sfSiteStructurePlugin:サイトマップとパンくずリストの自動生成

GWに会社の人と開発合宿に行ってきました。開発時間をたくさん取れる良い機会でなので、symfonyのプラグインを作りました。コードを公開しますので、よければ使ってみてください。

YAMLでサイト構造を書いておけば、そこからサイトマップとパンくずリスト(topic path)を自動生成できるプラグインで、sfSiteStructurePluginと名付けました。

コードはページの最後にあります。

必要要件

symfony1.0系
※symfony1.1は動作未確認

サイト構造に含めたいページはすべて app/*/config/routings.yml にルーティング名を設定しておく必要があります。

特徴

出力結果を見た方が早いでしょう。

 

こんな感じで出力されます。

導入

手順

• sfSiteStructurePluginディレクトリをsymfonyプロジェクトのpluginsに置く。
• サイト構造を記述したyamlをapp/*/config/structure.ymlに用意する。
• app/*/config/settings.ymlのenabled_modulesに sfSiteStructure を足す。
• 表示させたい場所に include_compornent する

これを出すには、以下のようなyamlファイルを書くだけでokです。

 yamlとサイトマップを見るとわかりますが、"@routing_name?id=123"のようなページ(私は動的と呼んでいます)にも対応します。

この部分ですね、動的(xxカテゴリの一覧)の下に動的(商品詳細)が来る場合でも大丈夫です。

使い方については別途記事にします。動的の対応方法などはちょっと面倒なので…。

ひとまずはsfSiteStructurePluginを使ったサンプルサイトを用意しましたので、待ちきれない方はそちらを見てなんとかしてみてください。

sfSiteStructurePlugin ver 0.7.0 ダウンロード

• プラグイン本体
  • sfSiteStructurePlugin-0.7.0.zip
  • sfSiteStructurePlugin-0.7.0.tar.gz
• サンプルサイト"とっても スイーツ屋"
  • SampleSite_sfSiteStructurePlugin-0.7.0.zip
  • SampleSite_sfSiteStructurePlugin-0.7.0.tar.gz

注意点

• ほとんどテストしていないので、バグがあると思います。
• 負荷は気にせず組んでありますので、多分重いです。サイトマップは特にキャッシュ推奨です。サイト構造ツリーは何らかのキャッシュを考えないといけないなぁ。
• ulとliタグでデザインしてあります。他のタグを使いたい場合は根性でなんとかしてください。
• 動的は一応レベルでの対応なので、かゆいところには手が届かないでしょう。何が足りないか連絡してもらえれば、気分で対応するかもしれません。