メインコンテンツに移動

メインナビゲーション

  • ホーム
  • サイトマップ
  • ビデオ
  • ご連絡

パンくず

  • ホーム
  • Drupal8でのカスタム・エンティティをコマンドラインで作成する方法

Drupal8でのカスタム・エンティティをコマンドラインで作成する方法

drupal
module
system_management
command

Drupal7よりD8のカスタムモジュール・エンティティ作成が簡単

  • Drupal7では、カスタムモジュール(Custom Module)、エンティティ(Entity)自作するには随分コーティングする必要はあります
    • 例:DrupalのEntityを定義する簡単な例
  • Drupal8では、カスタムモジュール、エンティティのテンプレート作成にはDrupal、Drushコマンドの使用ができます

Drushコマンドでカスタムモジュール・エンティティのテンプレート作成

  • 最新のDrush(9.7)をインストールします
    • composer require drush/drush
  • 以下のDurshコマンドでカスタムモジュール・エンティティのテンプレートを作成
    • drush generate module-content-entitygenerate a template of drupal custom module/entity/content
    • twodrill@2drill.net [~/public_html/2drill_dev]# drush generate module-content-entity
      
       Welcome to module-content-entity generator!
      –––––––––––––––––––––––––––––––––––––––––––––
      
       Module name:
       ➤ Entity Test
      
       Module machine name [entity_test]:
       ➤
       Package [Custom]:
       ➤
       Dependencies (comma separated):
       ➤
       Entity type label [Entity Test]:
       ➤
       Entity type ID [entity_test]:
       ➤
       Entity base path [/admin/content/entity-test]:
       ➤
       Make the entity type fieldable? [Yes]:
       ➤
       Make the entity type revisionable? [No]:
       ➤
       Make the entity type translatable? [No]:
       ➤
       The entity type has bundle? [No]:
       ➤ Yes
       Create entity template? [Yes]:
       ➤
       Create CRUD permissions? [No]:
       ➤
       Add "title" base field? [Yes]:
       ➤
       Add "status" base field? [Yes]:
       ➤
       Add "created" base field? [Yes]:
       ➤
       Add "changed" base field? [Yes]:
       ➤
       Add "author" base field? [Yes]:
       ➤
       Add "description" base field? [Yes]:
       ➤
       Create REST configuration for the entity? [No]:
       ➤
       The following directories and files have been created or updated:
      –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
       • modules/custom/entity_test/config/schema/entity_test.entity_type.schema.yml
       • modules/custom/entity_test/entity_test.info.yml
       • modules/custom/entity_test/entity_test.links.action.yml
       • modules/custom/entity_test/entity_test.links.menu.yml
       • modules/custom/entity_test/entity_test.links.task.yml
       • modules/custom/entity_test/entity_test.module
       • modules/custom/entity_test/entity_test.permissions.yml
       • modules/custom/entity_test/src/Entity/EntityTest.php
       • modules/custom/entity_test/src/Entity/EntityTestType.php
       • modules/custom/entity_test/src/EntityTestInterface.php
       • modules/custom/entity_test/src/EntityTestListBuilder.php
       • modules/custom/entity_test/src/EntityTestTypeListBuilder.php
       • modules/custom/entity_test/src/Form/EntityTestForm.php
       • modules/custom/entity_test/src/Form/EntityTestTypeForm.php
       • modules/custom/entity_test/templates/entity-test.html.twig
      

       

drupal
module
taxonomy
field

タクソノミー・タームの選択ツールについて

  • 記事編集画面でタクソノミー・ターム(例:タグ)などの初期選択ツールが自動補完/セレクトボックスなどがあります
  • Drupal7では:Hierarchical Select モジュールをよく使用しました。
    • とてもシンプルとは言えないですが、使いやすいモジュールでした
    • 選択だけではなく、新規タームの作成もできました
  • Drupal8では: Hierachical SelectモジュールはDrupal8のバージョンを提供していない
    • Drupal8では、Simple Hierarchical Select, Chosen などのモジュールがあります
    • 階層別で選択では、Simple Hierachical Selectでは十分機能しています
    • Chosenはサードパーティーのモジュールで、jsライブラリのダウンロード/インストールが必要です

モジュール(Simple Hierachical Select)が使いやすいが問題があり

  • 現時点では、Simple Hierachical Selectモジュールのバージョン:8.x-1.0-alpha4
  • モジュールを通常にインストールして、設定画面で、新規ターム作成許可のチェックボックスが無効化されています
    新規ターム作成チェックボックスが無効されている
  • この点をインターネットで調べてみたら、実際に解決されていない問題があります
    • 詳細説明ページ:https://www.drupal.org/project/shs/issues/2712115
    • パッチ幾つかが提供されていますが、根本的な対応策が見つかっていないようです
    • でも、ターム新規作成をしなければ、このモジュールが十分使えます
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
customization
drupal
content type
entity type

Drupal7の基本

  • Drupal7の初期コンポーネントはいくつかしかない
    • Content Type: Article ⇒ 記事の構造(コメント機能、例Blogの構造)、Basic Page ⇒ Articleと似ている、単純的なページの機能(コメント機能なし、ほかにはArticleと同じ)
    • Taxonomy: タグをつける機能。データのツリー構造、キーワード/タグとして、記事の纏めに役に立つ
    • People: ユーザーのプロファイル、ログイン、アクセス権限などに利用される
    • Menu: メニューの構成を管理する
    • Block: ページの構成、コンテンツがどこに表示するかなどの管理
    • Appearance: サイト全体の構成、テーマ、表示などの管理
    • その他
  • 記事などのデータ/コンテンツ管理は:Content Type、Taxonomy、Peopleなど
  • 記事などのデータ/コンテンツの表示管理は:Menu、Block、Appearenceなど
  • 上記機能だけで、簡単なウェブサイト構築が可能となる

Contentsについて

  • ウェブページ上に表示されている内容がコンテンツです <- エンドユーザーからの視点から見る
    • コンテンツがContents Type(同じフィールドを持ち)に分類され、一つのコンテンツ・タイプが複数のコンテンツから構成されます。
  • 一つウェブサイトに複数のコンテンツ・タイプがあります。
    • Drupal7の初期コンテンツタイプ:Article、Basic Page。ほかにBook Page、Forum topic、Pollなどがインストールされている(無効化されている)
    • ユーザーが必要なフィールド及びフィールドの入力/表示方式を決めて、新しいコンテンツタイプの作成が出来る
    • コンテンツタイプにある各フィールド、フィールドの入力制御、フィールドの表示などを管理するルーツCCK(Content Constructuion Kit)がDrupal7に初期インストールされている

Nodeについて

  • Drupal での重要なコンセプトは、すべてのContentsをノードとして保管するということです。
  • Nodeはシステムの基本ビルディング・ブロックで、これを基礎としてDrupal に保管されたコンテンツを拡張します。
  • 開発者は新しいノード・モジュールを作成することによって、それぞれのサイトのニーズに特有の追加フィールドをデータベースに定義し、保管できます。
  • Nodeはタイプによって分類されます。各ノード・タイプの操作とレンダリング方法は、そのユース・ケースに基づいて変えることができます。
  • 標準ノード・タイプには、以下のものが含まれます。
    • ページ (Pages): コンテンツを表示するためのシンプルなノード。PHP を使用して、コンテンツを動的に更新できます。コンテンツのどの部分でも、PHPを組み込むことによって動的にすることができます。
    • ブログ・エントリー (Blog entry): オンライン・ジャーナルやウェブログを保持するノード。
    • フォーラム (Forum): ノードとそれぞれのコメントのセット。これらのノードは、タクソノミー (taxonomy:分類方法) を割り当てることによってグループ化されます。
    • ストーリー (Story): 一定の日付が過ぎると期限切れになる汎用ページ。通常のページと同様ですが、スタイルを変えることができます。
    • コメント (Comment): 特殊なタイプのコンテンツで、他のノードで定義されたコンテンツに関するコメントをユーザーが追加できます。コメントはノードのタイプではないため、データベースの別個のテーブルに保管されます。
  • データベースは、Nodeに関する基本的な情報一式を記録します。
    • この情報には、タイトル、簡単な記述(または要約)、および本文が含まれます。
    • 作成者、作成時間、ステータスに関する情報も記録されます。通常、アプリケーションに必要な情報を追加するには、新しいノード・タイプを作成し、そのノード・タイプに対して明確に定義されたデータベース・テーブルに書き込む必要があります。
  • Drupal は、ノード・コンテンツに加えられた変更に対応するためのリビジョン・システムをインプリメントします。モジュール開発者はこのシステムを使用して、ノード・リビジョン専用に割り振られたテーブル内のそれぞれのノード更新に対する新規データベース・レコードを切り取ることができます。詳細は、Drupal revisions overhaul に記載されています。
  • 詳細な説明はここです。

Entityについて

  • Drupal7ではContent TypeがNodesとも言われている:いろいろなコンテンツがNodesの扱いとなる
    • Nodes: すべてのコンテンツをノードとして保管するということです。ページ、アンケート、記事、フォーラム、Blogなどを指している
    • CommentsがNodeではない。Commentsがいつもコンテンツ(例Articleなど)に付加されているし、単独な存在はしない。
    • Nodesの大きな特徴は、いろいろなフィールド(Text、image、Fileなど)が自由自在に追加されることができる。入力フォームと表示フォームの管理ができる。作成者、作成年月日などのプロパティがある。メニュー/表示管理ができる
  • Drupal7のEntityはユーザー、コメント、ノートなどの元となる概念
    • Drupal7 Dataで見ると以下のような構造となる
      • Custom Database table
      • Entity
        • User
        • Comment
        • File
        • Taxonomy Vocabulary
        • Taxonomy term
        • Node(・Page, ・Blog post, ・Articleなど)
      • Custom entity Type
  • Entityの構造はEntity Type、Entity、Bundleのようなもの
    • Entity Type: いろいろなコンテンツタイプ(Nodes (content), Comments, Taxonomy terms, User profiles)がEntity Typeの一種類となる
    • Entity: Entity Typeのインスタンス。
    • Entity Properties: Entity Typeの共通項目をプロパティで表現する(例:Content typeは作成者、作成日付、アクセス権限などがContent typeのプロパティとなる)
    • Bundles : 各Entity Typeで生成されたオブジェクトの束(例:車のEntityTypeに乗用車、トラック、救急車などのBundlesがある)
    • Fields: 各Entityに追加された項目(Entity Properties以外のもの、共通なものではない)

Entity と Nodesの違い

Nodes                          Entities

  • サイトにすでに存在                  オプションで追加
  • コンテンツ、フィールドなどをUIで追加       開発に利用することが多い、UIのサポートが少ない
  • バージョン管理でリリース              個人での管理
  • データがNodeテーブルに保存           データ保存の個人管理可能
  • 各ケースに必要のないパーツも削除できない  すべてのパーツが自由に組わせ、拡張性とパフォーマンスが良い
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
drupal

Durupl8ではテーマは単独のディレクトリで管理

  • Drupal8のテーマ(theme)がモジュールのインストール/アンインストール(機能拡張)の部分でインストールすることができます
    • 「テーマ」管理画面でも「新しいテーマのインストール」ボタンをクリックして、インストールすることがもできます
  • 通常モジュールのフォルダー(drupal8/modules)と違って、単独のフォルダー(drupak8/theme)で管理しています
    Drupal8はモジュール/テーマは別フォルダー

インストールしたテーマ(theme)にカスタマイズのため、サブテーマ(sub-theme)の作成ができます

  • いろいろテーマをインストールすることができます
  • インストールしたテーマの一部分をカスタマイズをしたいことがよくあります
    • 例:個別の詳細をcssで定義して、cssファイルをテーマに追加したい
  • Drupalでは複数のサブテーマ(sub-theme)を作成することができます
  • 複数のサブテーマを並列/直列して親テーマに継承することができます
    Drupalの複数のサブテーマを直列/並列で
  • 子テーマが親テーマの要素を継承します
    • 子テーマで各要素の再定義、追加などができます

テーマ/サーブテーマのディレクトの集約ができます

  • 初期のテーマディレクトリにインストールした複数のテーマが入っています
  • サブディレクトもテーマディレクト(drupal8/theme)に作成して保管しています
  • 複数のテーマをインストールして、複数のサブテーマを作成したら、フォルダー数が多くなり、どっちがサブテーマかはわかりづらくなります
  • ここで、元のテーマを集約するディレクトリ(contrib)、とカスタマイズのサブテーマのディレクトリ(custom)を作成して、集約することができます元テーマ/サブテーマのディレクトリ集約
    • themes
          +-- contrib
                   +-- theme 1
                   +-- theme 2
                   +-- theme ・・・
          +-- custom
                   +-- sub_theme 1
                   +-- sub_theme 2
                   +-- sub_theme ・・・
       
  • 作成された集約ディレクトリ(例:contrib, custom)、各テーマ/サブテーマのディレクトリを移動します
    • 移動後に各テーマ/サブテーマの構成ファイル(例:_info.yml)の定義の修正(ディレクトリ名に合わせ)必要はありません

 

drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

エンティティ(Entity)に一つ以上のバンドル(Bundle)の定義ができます(カスタムモジュールentity_room.zip)

  • エンティティ(Enityt)の定義(hook_entity_info)にバンドル(bundle)定義があります('bundle'=>array())
    • バンドル定義に空の配列(bundle =>array())として定義する場合エンティティ(Entity)名と同じバンドルが自動的に定義されます
  • 一つエンティティに複数のバンドル定義ができます(カスタムモジュールentity_room.zip をダウンロード)
    • 例: roomエンティティに、シングルタイプルーム(single room)とツインタイプルーム(twin room)のバンドル(bundle)があります
      DrupalのEntityに複数のバンドル(Bundle)定義
    • 複数のバンドル定義するエンティティは以下のようです
      /**
       * Implements hook_entity_info().
       */
      function entity_room_entity_info()
      {
          $room_info['room'] = array(
              'label' => t('Room'),
              'entity class' => 'Entity',
              'controller class' => 'DrupalDefaultEntityController',
              'base table' => 'room',
              'fieldable' => TRUE,
              'entity keys' => array(
                  'id' => 'rid',
                  'label' => 'room_number',
                  'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
              ),
              'bundles' => array(
                  'single_room'=> array(
                      'label' => 'Single Room',
                      'admin' => array(
                          'path' => 'admin/structure/single-room/manage',
                      ),
                  ),
                  'twin_room'=> array(
                      'label' => 'Twin Room',
                      'admin' => array(
                          'path' => 'admin/structure/twin-room/manage',
                      ),
                  ),
              ),
              'access callback' => 'access_room',
              'module' => 'entity_room',
          );
      
          return $room_info;
      }
      

バンドルのフィールド管理パス、権限の設定が必要です

  • 各バンドル(Bundle)にそれぞれの拡張フィールド管理ができます
  • そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
    • single room: 'path' => 'admin/structure/single-room/manage',
    • twin room: 'path' => 'admin/structure/twin-room/manage',
  • 各バンドルに対してエンティティでアクセス権限一括設定ができます
    • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

  • 一エンティティ(Entity)ごとに、DB上では一テーブルとなります
    • 上記例はroomテーブル(entity_room.installを参考)
  • 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
    • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
  • DB上のバンドル識別フィールドをentity_keysに設定する必要があります
    • 上記では、'bundle' => 'room_type',
  • このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

  • バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません(継承関係でバンドルが下位になっています)
  • プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します(実際にフィールド管理画面でプロパティの編集はできない)
    /**
     * Implements hook_field_extra_fields().
     * Field管理にRoomのプロパティ項目を追加(編集不可)
     */
    function entity_room_field_extra_fields()
    {
        $return = array();
        // For Single Room Bundle
        $return['room']['single_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
        // For Twin Room Bundle
        $return['room']['twin_room'] = array(
            'form' => array(
                'room_type' => array(
                    'label' => t('Room Type'),
                    'description' => t('The type of the room'),
                    'weight' => 1,
                ),
                'room_number' => array(
                    'label' => t('Room Number'),
                    'description' => t('The number of the room'),
                    'weight' => 2,
                ),
            ),
        );
    
        return $return;
    }
    

エンティティの取得、作成などの操作にhook_menu()を実装して行います

  • エンティティの取得、作成などはhook_menu()を実装します
  • エンティティ作成、表示にはFormAPIなどを実装しています
    /**
     * Implements hook_menu().
     */
    function entity_room_menu()
    {
        // シングル ルーム 管理画面
        $items['admin/structure/single-room/manage'] = array(
            'title' => t('Single Room Admin'),
            'description' => 'Manage Single Room structure',
            'page callback' => 'room_info',
            'page arguments' => array('Single Room') ,
            'access arguments' => array('administer rooms'),
        );
        $items['single-room/add'] = array(
            'title' => t('Add Single Room'),
            'page callback' => 'room_add',
            'page arguments' => array('single_room'),
            'access arguments' => array('create room'),
        );
    
        // ツインルーム管理が画面
        $items['admin/structure/twin-room/manage'] = array(
            'title' => 'Twin Room Admin',
            'description' => 'Manage Twin Room structure',
            'page callback' => 'room_info' ,
            'page arguments' => array('Twin Room'),
            'access arguments' => array('administer rooms'),
        );
        $items['twin-room/add'] = array(
            'title' => t('Add Twin Room'),
            'page callback' => 'room_add',
            'page arguments' => array('twin_room'),
            'access arguments' => array('create room'),
        );
    
        // Roomの表示
        $items['room/%room'] = array(
            'title callback' => 'room_page_title',
            'title arguments' => array(1),
            'page callback' => 'room_page_view',
            'page arguments' => array(1),
            'access arguments' => array('view rooms'),
            'type' => MENU_CALLBACK,
        );
    
        return $items;
    }
    
    /**
     * Implements hook_permission().
     */
    function entity_room_permission()
    {
        return array(
            'administer rooms' =>  array(
                'title' => t('Administer rooms'),
                'restrict access' => TRUE,
            ),
            'create room' =>  array(
                'title' => t('Create room'),
            ),
            'view rooms' => array(
                'title' => t('View Rooms'),
            )
        );
    }
    
    /**
     * 全員にRoomエンティティの無条件アクセス権限
     */
    function access_room(){
        return true ;
    }
    
    /**
     * create "add room" form
     */
    function room_add($type) {
        $room = (object) array (
            'rid' => '',
            'room_type' => $type,
            'room_number' => '',
        );
    
        return drupal_get_form('room_add_form', $room);
    }
    function room_add_form($form, &$form_state, $room) {
        $form['room_type'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Type'),
            '#default_value' => $room->room_type,
            '#disabled' => true,
            '#required' => TRUE,
        );
    
        $form['room_number'] = array(
            '#type' => 'textfield',
            '#title' => t('Room Number'),
            '#required' => TRUE,
        );
    
        field_attach_form('room', $room, $form, $form_state);
    
        $form['submit'] = array(
            '#type' => 'submit',
            '#value' => t('Save'),
            '#weight' => 10,
        );
    
    
        return $form;
    }
    
    function room_add_form_validate($form, &$form_state) {
        $room_submisttion = (object) $form_state['values'];
        field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
    }
    
    function room_add_form_submit($form, &$form_state) {
        $room_submission = (object) $form_state['values'];
        field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
        $room = room_save($room_submission);
        $form_state['redirect'] = "room/$room->rid";
    }
    
    function room_save(&$room) {
        drupal_write_record('room', $room);
        field_attach_insert('room', $room);
        return $room;
    }
    
    
    function room_info($type) {
        return t('Welcome to the administration page for your '.$type.'!');
    }
    
    function room_page_title($room){
        return $room->room_number."(".$room->room_type.")";
    }
    
    function room_page_view($room, $view_mode = 'full'){
    
        $room->content = array();
    
        // Build fields content.
        field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
        entity_prepare_view('room', array($room->rid => $room));
        $room->content += field_attach_view('room', $room, $view_mode);
    
        return $room->content;
    }
    
    function room_uri( $room ){
        return array(
            'path' => 'room/'.$room->rid ,
        );
    }
    
    class RoomController extends EntityAPIController{
    //class RoomController extends DrupalDefaultEntityController{
        public function __construct($entityType) {
            parent::__construct($entityType);
        }
    
        // Entityオブジェクト保存
        public function save($room) {
            drupal_write_record('room', $room);
            field_attach_insert('room', $room);
            return $room;
        }
    
    }
    
    /**
     * hook_menuのURL引数のオブジェクト取得
     */
    function room_load($rid = NULL, $reset = FALSE){
    
        $rids = (isset ($rid) ? array($rid) : array());
        $room = room_load_multiple($rids, $reset);
        return $room ? reset ($room) : FALSE;
    }
    
    function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
        return entity_load('room', $rids, $conditions, $reset);
    }
    

 

添付 サイズ
entity_room.zip (2.84 KB) 2.84 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

一つのエンティティタイプ(Entity Type)に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ(Entity Type)が必要
    • 例: 記事(Article)、基本ページ(Basic Page)を作成する前に、コンテントタイプが必要です(コンテントタイプ⇒エンティティタイプです、記事/基本ページはバンドルです)
  • 前回紹介した「DrupalのEntityを定義する簡単な例-4:複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル(例:シングルタイプ、ツインタイプのルーム)を定義します

問題点:プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例:ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例:コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル(例:予約など)追加ができます

解決:エンティティ(Entity)を利用して別のエンティティタイプのバンドルに定義します

  • モジュール:EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ(例:room type)を別のエンティティタイプ(例:room)のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ(EntityType)のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義: "bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します(前回も紹介したので、ここは詳細を省略)
  • 他のエンティティタイプのバンドルにする定義: "bundle of" => "room"  (room typeがroomのバンドルに指定)
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • カスタムモジュール(entity_room.zip)をダウンロードしてください
  • エンティティの具体な操作は次回で説明します
添付 サイズ
entity_room.zip (5.08 KB) 5.08 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
video
entity type

やりたいこと:Entityのプロパティをフィールドのように表示管理を行いたいです

  • 前回紹介した:「DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義 」例があります
    • Entityの表示は「entity_view()」関数を使用しました
      function room_view($room, $view_mode="full") {
      
          drupal_set_title(entity_label('room', $room));
      
          return entity_view('room', array(entity_id('room', $room) => $room), $view_mode);
      }
    • Roomエンティティのプロパティ(RoomNam、RoomArea←今回追加した)のRoom表示画面に表示できません
      エンティティの表示画面にエンティティプロパティが表示されていない
    • なぜRoomNameが表示されたか: hook_entity_info() の「entity keys」の「label」に定義されて、エンティティのタイトルとして表示させた
    • もちろん、FormAPIを利用して、RoomName/RoomAreaの表示ができます。ここで、Entity CRUD(EntityAPIに提供され)機能を利用してエンティティを表示させます

エンティティプロパティ(Entity Properties)を表示させるためEntityDefaultExtraFieldsControllerの実装が必要です

  • 今回「EntityDefaultExtraFieldsController」の実装例サンプル:entity_room.zip をダウンロードしてください
  • hook_entity_info定義に「'extra fields controller class' => 'EntityDefaultExtraFieldsController',」入れます
    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $return = array(
            'room' => array(
                'label' => t('Room'),
                'entity class' => 'RoomEntity',
                'label callback' => 'entity_class_label', // see RoomEntity class
                'uri callback' => 'entity_class_uri',     // see RoomEntity class
                'controller class' => 'RoomController',
                'base table' => 'room',
                'fieldable' => TRUE,
                'entity keys' => array(
                    'id' => 'rid',
                    'bundle' => 'room_type_sys',
                ),
                'bundle keys' => array(
                    'bundle' => 'room_type_sys',
                ),
                'bundles' => array(),
                'load hook' => 'room_load',
                'view modes' => array(
                    'full' => array(
                        'label' => t('Default'),
                        'custom settings' => FALSE,
                    ),
                ),
                'module' => 'entity_room',
                'access callback' => 'entity_room_access',
                'extra fields controller class' => 'EntityDefaultExtraFieldsController',
                'metadata controller class' => 'RoomEntityMetadataController',
            ),
        );
        $return['room_type'] = array(
            'label' => t('Room Type'),
            'entity class' => 'RoomTypeEntity',
            'controller class' => 'RoomTypeController',
            'base table' => 'room_type',
            'fieldable' => FALSE,
            'bundle of' => 'room',
            'exportable' => TRUE,
            'entity keys' => array(
                'id' => 'rtid',
                'name' => 'room_type_sys',
                'label' => 'room_type_label',
            ),
            'module' => 'entity_room',
            'admin ui' => array(                // Enable the entity API's admin UI.
                'path' => 'admin/structure/room-types',
                'file' => 'room_type.admin.inc',
                'controller class' => 'RoomTypeUIController',
            ),
            'access callback' => 'entity_room_access',
        );
    
        return $return;
    }
    
  • エンティティプロパティの情報を定義するため、hook_entity_infoに「'metadata controller class' => 'RoomEntityMetadataController', 」入れます
    class RoomEntityMetadataController extends EntityDefaultMetadataController {
        public function entityPropertyInfo()
        {
            $info = parent::entityPropertyInfo();
            $info[$this->type]['properties']['rid']=array(
                'label' => t('Room ID'),
                'type' => 'integer',
                'description' => t('Room Entity ID'),
                'schema field' => 'rid',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_type_sys']=array(
                'label' => t('Room Type Name'),
                'type' => 'text',
                'description' => t('Room Type Machine Name'),
                'schema field' => 'room_type_sys',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_label']=array(
                'label' => t('Room Name'),
                'type' => 'text',
                'description' => t('Room Name'),
                'schema field' => 'room_label',
                'setter callback' => 'entity_property_verbatim_set',
            );
            $info[$this->type]['properties']['room_area']=array(
                'label' => t('Room Area'),
                'type' => 'text',
                'description' => t('Room Area Name'),
                'schema field' => 'room_area',
                'setter callback' => 'entity_property_verbatim_set',
            );
            return $info;
    
        }
    }
    
  • hook_entity_infoに「'metadata controller class'  」を利用せず、「 hook_entity_property_info() 」を実装してもできます

エンティティ管理画面の「フィールド管理」/「表示管理」にエンティティのプロパティが表示される

  • 「表示管理」でプロパティの表示/非表示設定ができます
    エンティティのプロパティの表示/日表示設定
  • エンティティ表示画面にエンティティのプロパティが表示されるようになります
     

 

添付 サイズ
entity_room.zip (6.47 KB) 6.47 KB
Embedded thumbnail for DrupalのEntityを定義する簡単な例-7:EntityDefaultExtraFieldsControllerを実装してエンティティのプロパティを表示させます
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
drupal
entity type

D7ではエンティティ(Entity)に対応していないサードパーティーのモジュールが数多く存在しています

  • Drupal7現時点でも、エンティティタイプ(EntityType)に対応しているモジュールが数多く存在しています
  • エンティティをサポートするサブモジュール/パッチが登場したモジュールが多いです(特にメジャーなモジュール)
  • D7でエンティティを導入する場合、各モジュールがエンティティとの対応チェックは必要でしょう
    • エンティティが導入後に、一部分でエンティティを対応しなければ、サイトの機能に影響を与えかねないです

エンティティ()に対応するサブモジュール/パッチをネットでチェックします

  • 前回エンティティの定義:DrupalのEntityを定義する簡単な例-6:EntityAPI(EntityAPIControllerExportable)でバンドルの管理画面の定義
    • この例のRoomエンティティを例にします
  • よく使用されているモジュール(例:xml sitemap, pathautoなど)もエンティティタイプを対応していないです
  • モジュール(xml sitemap)の場合エンティティ対応のパッチが出ています
    • パッチ当て後に、xml sitemapの管理画面に定義したエンティティタイプが現れます
      モジュール(xml sitemap)のエンティティタイプ対応パッチ
  • モジュール(pathauto)ではエンティティ対応するサブモジュール(Pathauto Entity)があります
    • モジュールをインストールすれば、URLエリアスの管理画面に「エンティティ」タブが現れ、必要なエンティティタイプを選択することができます
      モジュール(pathauto entity)よりエンティティタイプの選択
Embedded thumbnail for Drupalのモジュール(EntityAPI)に対応していないサードパーティーのモジュールが多く存在しています
drupal
entity type

モジュール(EntityAPI)がDrupalコアにある「entity」を拡張したものです

  • モジュール(EntityAPI)はAPIモジュールであり、エンドモジュールではありません(インストール後に画面には何の変化もありません)。Drupalへのカスタマイズ、開発するためにAPIです。
    • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター: "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
  • プログラミングでEntityを定義する例(DrupalのEntityを定義する簡単な例-3:バンドルの作成/拡張フィールド追加)では、コアのEntity(DrupalDefaultEntityController)を使用した例です

EntityAPI(EntityAPIControllerExportable)を実装してバンドルの管理画面を定義します

  • EntityAPI実装よりEntity自身をほかのntityのバンドル(Bundle)にすることことができます
    • 例: DrupalのEntityを定義する簡単な例-5:エンティティ(Entity)を利用して別のエンティティタイプ(Entity Type)のバンドルに作成
  • hook_entity_info() のバンドルを管理するUIの定義パラメーター: ”admin ui” => array()
    • "exportable" => TRUE : エンティティ定義のエクスポートができるかの定義
    • "fieldable" => TRUE :  フィールドの拡張可能かの定義(バンドル(room type)内で定義ではなく、エンティティタイプ内で定義:上記例ではroomエンティティで定義)
      DrupalのEntityAPIでバンドル管理画面を定義

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

  • バンドル管理画面(RoomType管理)でバンドルを作成します
  • 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
  • これらの操作をできるように、hook_entity_info_alter()の実装が必要です
    /**
     * 追加されたバンドル(RoomType)に拡張フィールド操作URIの追加
     * Implements hook_entity_info_alter().
     */
    function entity_room_entity_info_alter(&$entity_info)
    {
        foreach (room_types() as $type => $info) {
            $entity_info['room']['bundles'][$type] = array(
                'label' => $info->room_type_label,
                'admin' => array(
                    'path' => 'admin/structure/room-types/manage/%room_type',
                    'real path' => 'admin/structure/room-types/manage/' . $type,
                    'bundle argument' => 4,
                ),
            );
        }
    }
    
    // room_type_sys でデータの取得
    // room_type入力がなければ、全部のRoomTypeを返す
    function room_type_load($room_type=null){
        return room_types( $room_type ) ;
    }
    
    function room_types( $room_type = null ){
        $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
        return isset( $room_type ) ? reset($types) : $types ;
    }
    
    • なぜhook_entity_info_alter()の実装が必要か?バンドル(room_type)が作成する前にエンティティの実体がないからです(上記例では必要に応じでバンドル作成)
    • 後ろにある「function room_type_load()」はパスにあるワイドカード( 'path' => 'admin/structure/room-types/manage/%room_type')に使用されます
  • hook_entity_info_alter()を実装しない、または間違って実装(例:pathのワイドカード使用不正)すると拡張フィールド管理ページが見つからないエラーになります
    hook_entity_info_alterを実装しない、または間違って実装すると拡張フィールド管理画面が見つからないエラー

エンティティをバンドルにするデータ構成:エンティティタイプの識別キーが必要

  • 上記例のエンティティタイプ、バンドルの関係は以下のようです
    • エンティティタイプ(entity type) : room
    • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など(必要に応じて作成)
  • 作成したエンティティ本体(room)がバンドル(single_type, twin_type)どの関連があるので、二つのテーブル間の参照キーが必要となります
    • 例: 1001室 ⇒ シングル(single_type)、2001室(twin_type)
    • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
      EntityTypeとBundleの間に参照キーが必要
添付 サイズ
custom_table_2.zip (1.67 KB) 1.67 KB
ホーム

古松

検索

Article Category

  • apache(7)
  • css(19)
  • drupal(295)
  • Electron(4)
  • html(34)
  • javascript(27)
  • laravel(4)
  • linux(5)
  • macOS(2)
  • mysql(13)
  • php(19)
  • python(4)
  • SEO(12)
  • video(72)
  • Visual Studio Code(4)
  • windows(13)
  • wordpress(32)