baserCMS Advent Calendar 2018 参加記事です。
概要
- baserCMSを理解するための情報をまとめています。
- リンク先の中には、情報が古くてそのままのコードだと動かない場合もありますが、その際は考え方だけ掴むといいでしょう。
対象
- PHPの基本的な使い方を理解している方
- baserCMSの基本的な使い方を理解している方
- baserCMSを使用したテーマの作成やプラグインの作成を行いたい方
1. baserCMSの環境を準備する
- ローカルにbaserCMSの環境がない方は最初に準備しましょう。
- サーバー上にしか環境がない場合よりもスムーズに作業が行なえます。
- Windowsの場合はXAMPP、Macの場合はMAMPを使用すると簡単に開発環境が準備できます。
- baserCMS 公式サイト
- baserCMS はじめてガイド
- XAMPP 公式サイト
- MAMP 公式サイト
2. テーマの作り方
- 最初は既存のテーマに変更を加えてカスタマイズの仕方を覚えましょう。
- baserCMSでテーマをカスタマイズする場合は「どのファイルを変更すればいいのか」を見つけることと、 baserCMSにどのような関数が準備されているのかを知ることが重要です。
- basersマガジン テーマの作り方
- baserCMS公式ガイド テーマ制作チュートリアル
- baserマーケット テーマ一覧
2.1. 変更対象ファイルの見つけ方
-
変更対象のファイルを見つける方法として、私はよく「それっぽい文字列」での全文検索か、ファイル名の検索を行っています。
-
例えば、bc_sampleテーマを使用している場合にトップページに表示されるブログ記事の表示を調整したいとしましょう。
-
その際は、まず変更したい箇所のソースをチェックします。ブラウザのデベロッパーツールを使うと便利です。
-
「post-list」という文字列を見つけたので、bc_sampleテーマ配下で全文検索を行います。
-
2件見つかりました。片方のパスには"smartphone"と入っているので、PC版の場合は"Blog/default/posts.php"を変更するとよさそうです。
2.2. baserCMSの関数
- 関数は公式wikiの関数リファレンスを一通り見ておくといいです。すべてが網羅されているわけではありませんが、最低限の関数の情報は準備されています。
3. プラグインの作り方
- プラグインを作れるようになるとbaserCMSに様々な機能を加えることができるようになります。
- baserCMSに標準で準備されているブログ機能やメール機能もプラグインの一種です。
- プラグインを実際に作り始める前にCakePHP2の基本的な知識を身につけることをおすすめします。
- baserCMSは、CakePHP2をベースに作成されているため、プラグインを作成する際もCakePHP2の知識が必要となってくるからです。
3-1. CakePHPを学ぶ
- 3時間濃縮CakePHP2.1 in PHPカンファレンス北海道2012
- ドットインストール CakePHP2入門
- CakePHP 2.x ブログチュートリアル
- CakePHP 2.x ドキュメント
- Amazon はじめてのCakePHP
- Amazon CakePHP2 実践入門
3-2. プラグインの作り方を学ぶ
- baserCMS公式ガイド プラグイン作成ガイド
- basersマガジン プラグイン作成の基礎
- basersマガジン baserCMSのブログ機能にカスタム項目を追加するプラグインを作成する方法
- 私の場合、プラグインの作り方を覚える上で一番役に立ったのは既存プラグインの写経でした。
- baserマーケットやGitHubにあるプラグインで、簡単そうなプラグインをいくつかDLして、写経を行っていると段々とプラグインづくりの雰囲気がつかめてきます。
- baserマーケット プラグイン一覧
- GitHub baserCMS 検索結果
4. 困ったときは
- 開発を進めていく上で思うようにコードが動かないケースが出てくると思いますが、その際の対処法を記載します。
4-1. エラーログをチェックする
- baserCMSをデバッグモード1以上に設定するとPHPのエラーメッセージが画面上に表示されるようになります。
- 表示されたエラーメッセージで検索すると解決方法が見つかります。
- ajax関連の処理で画面上にエラーメッセージが表示されない場合は、ブラウザの開発者ツールのネットワークタブで通信先のページの情報が見られるので活用しましょう。
- baserCMS デバッグ方法
4-2. デバッガを使う
- NetBeansやPhpStormなどのIDEを使用すると、PHPの処理を1行ずつ進めながら変数の状態を確認するといったことが簡単に行なえます。
- また、IDEにはコードの補完機能や関数の定義元にジャンプする機能など、便利な機能が揃っているので開発を効率よく進めることができます。
4-3. フォーラムで質問する
- baserCMS公式のユーザーズフォーラムで質問すると、誰かが回答してくれるかもしれません。
以上となります。
テーマやプラグインを作成したら、ぜひbaserマーケットに投稿してみましょう。
私がありがたく使わせていただきます^^