-   topic   - トピックス

[baserCMS]スタッフ紹介プラグインの使い方

2015年07月29日 プレスリリース

いつも株式会社ヒニアラタのホームページをご覧いただき、誠にありがとうございます。

03add.png

この度、弊社ではbaserCMS用プラグイン「スタッフ紹介」を公開いたしました。 このソフトウェアは「baserマーケット標準販売ライセンス」で配布しております。 現在のところ、商用・非商用を問わず無償で使用(カスタマイズを含む)して頂けます

ダウンロード

baserマーケット

本プラグインの機能

このプラグインは、店舗や企業、劇団などの団体に所属しているスタッフさんを紹介する機能を提供します。

現行バージョン(Ver.0.9.1.1)での主な機能は以下の通りです。(2015/7/31現在)

  • ユーザーが管理画面で「スタッフ」を登録・編集できる
  • 登録された情報をフロントページで出力できる(一覧・個別)
  • 登録項目は「基本カテゴリ」「職能カテゴリ」「スキル(タグ)」「名前」「ふりがな」「紹介文」「血液型」。 さらに汎用項目を8個まで増やすことができ、ブログやTwitterのURLを登録するための「URL」を3つまで登録できる。画像は4枚までアップロード可能。
  • 利用項目設定により、不要項目を登録画面から非表示にできる
  • 利用項目設定により、「本文」入力欄にCKEditorを設定できる
  • 利用項目設定により、アップロード画像の最大サイズを設定できる
  • カテゴリは2種類(基本カテゴリ・職能カテゴリ)を用意
  • カテゴリとは別にタグとして使える「スキル」を実装。さらにスキルはスキルカテゴリ毎に分類できる
  • 登録されたスタッフデータとタグを管理画面で並び替えできる New!

それでは、実際の使い方をご紹介していきたいと思います。

インストールと利用項目の設定

インストールは通常のプラグインと変わりません。(ただし、webrootの「img」フォルダ内に「cast_plugin」フォルダを自動で生成しますので、 あらかじめ「img」フォルダのパーミッション等をご確認ください。)

まず、本プラグインをダウンロードして解凍します。その後でてきたフォルダ「Cast」を、 フォルダごとプラグイン用のフォルダにアップロードしてください(結果的に以下のようになります)。

  /app/Plugin/Cast/

アップロードが終わったら管理画面にログインします。管理画面の「プラグイン管理」に移動すると、以下の様な画面が表示されているはずです。

01install.png

ここで「スタッフ紹介」プラグインをインストールします。インストールのアイコン(青い矢印がある画像)をクリックします。 特に難しい作業はなく、必要なフォルダ等も自動で作成してくれます(登録画像を保存するフォルダを自動生成します)。

インストールが完了すると、管理画面右上の「システムナビ」や、 画面左の「よく使う項目」に「スタッフ紹介管理」が追加されます。そこからスタッフ紹介管理画面へ移動してください。

01install2.png

利用設定

インストールが出来たら、まずは利用設定を行うと良いでしょう(行わなくても機能は利用できます)。 利用設定では制作しているホームページの状況に合わせて、不要項目の設定やアップロードされる画像のサイズを変更できます。

05setting2.png

本プラグインには「汎用項目」という機能があり、最大8個まで自由に使えるテキストエリアを増やすことが出来ます。 今回は例として、「汎用項目1」を「星座」の入力欄として利用したいと思います。

06setting3.png

06setting4.png

なお、ここで設定できるのは以下の項目です。(※のついたものは登録画面から非表示にできます)

  • エディタタイプの選択
  • 画像1の利用(※)
  • 画像2の利用(※)
  • 画像3の利用(※)
  • 画像4の利用(※)
  • 汎用項目1の利用(※)と項目名
  • 汎用項目2の利用(※)と項目名
  • 汎用項目3の利用(※)と項目名
  • 汎用項目4の利用(※)と項目名
  • 汎用項目5の利用(※)と項目名
  • 汎用項目6の利用(※)と項目名
  • 汎用項目7の利用(※)と項目名
  • 汎用項目8の利用(※)と項目名
  • URL1の利用(※)
  • URL2の利用(※)
  • URL3の利用(※)
  • アップロード画像のサイズ

各設定の内容は下記の通りです。

エディタタイプの選択
本文入力欄について、CKEditor(リッチエディタ)にするか通常のテキストエリアにするかを選択できます。ブログのように自由に記述したい場合はCKEditorを選びます。逆にデザインなどが作りこまれており、自由な装飾をさせたくない場合は、 テキストエリアを利用すると良いでしょう。(baserCMSのシステム設定でCKEitorを使わない設定になっている場合、この設定に関わらず、本文入力欄は通常のテキストエリアで表示されます)
画像1〜4の利用
画像のアップロード欄を表示するかどうかを設定します。「使わない」にするとアップロード欄が非表示になります。
汎用項目1〜8の利用
汎用項目を表示するかどうかを設定します。「使わない」にすると入力欄が非表示になります。 また項目ごとに名前をつけることが出来ます。デフォルトでは「その他」になります。
URL1〜3の利用
URL入力欄を表示するかどうかを設定します。「使わない」にすると入力欄が非表示になります。

利用設定が終わったら、実際にデータを登録していきます。まずは基本カテゴリと職能カテゴリ登録から行っていきます。

カテゴリの作成と管理

07cate.png

基本カテゴリと職能カテゴリ

カテゴリを作成していきます。スタッフ登録はカテゴリがなくても可能ですが、 カテゴリがあるとカテゴリ毎のスタッフ表示ができたり、カテゴリ毎にコンテンツテンプレートを分けたりできます。

また、本プラグインには2つのカテゴリを用意しています。使い分けは自由ですが、制作側としては下記のような想定をして用意しました。

基本カテゴリ
いわゆるカテゴリです。例えば配属店舗や支店など、大きなくくりで利用します。
職能カテゴリ
職能ごとに分類することを想定しました。
例えば、美容室のスタッフ管理を行う場合を考えてみます。 基本カテゴリで配属店舗を設定します(◯◯店、××店など)。 その後、職能カテゴリで「店長」「スタイリスト」「アシスタント」「事務スタッフ」などのカテゴリわけをします。
2つのカテゴリを上手く使い分けることで、様々な職種のスタッフ紹介が可能になります。

なお、カテゴリ登録で登録できるのは「カテゴリ名」「コンテンツテンプレート」「利用設定」です。 (コンテンツテンプレートについては後述しています)

スキルとスキルカテゴリ

09skil.png

10skil.png

本プラグインではカテゴリとは別に「スキル」を登録する事ができます。これはブログでいうところの「タグ」に該当します。 自由な使い方ができますが、例えば「免許・資格」などで利用する方法があります。

なお、この「スキル」は「スキルカテゴリ」で分類することが可能です。 フロントページでの表示の際にも、専用ヘルパー(表示用の関数)を使ってスキルカテゴリ毎に表示させることが出来ます。

スタッフ情報の登録・編集・削除

新規登録と編集

いよいよスタッフを登録していきます。登録できる内容は以下の通りです。

基本カテゴリ
基本カテゴリを選択します。基本カテゴリはスタッフの所属等を設定するのに向いています。
職能カテゴリ
職能カテゴリを選択します。職能カテゴリはスタッフの職業的な属性を設定するのに向いています(職位や職種)。
スタッフ名
漢字で姓名を登録できます(登録は必須ですが、実際のページ上での表示は任意です)。
ふりがな
ふりがなを登録できます。片仮名、平仮名は区別しませんので自由にお使いいただけます。
ニックネーム
ニックネームを登録します。
スキル
複数選択できる項目です。スキルは「資格・免許」など、一人に対して複数登録する可能性があるものに向いています。
紹介文
スタッフ紹介の本文です。自由に記述できます。
血液型
血液型を登録できます。
生年月日
生年月日を西暦で入力します。
画像1〜4
画像を登録できます。利用設定で「使用しない」にすると項目を表示しません。
その他1〜8
汎用項目にテキストを登録できます。利用設定で「使用しない」にすると項目を表示しません。
URL1〜3
URLを登録できます。利用設定で「使用しない」にすると項目を表示しません。
公開設定
このスタッフ情報を公開するかどうか設定できます。

削除

登録されたデータを削除できます。削除したデータは元に戻りません。 また、そのスタッフ情報に登録されていた画像1〜4も同時に削除されます。ご注意ください。

削除の方法は2通りです。一覧画面の削除アイコン(×マークの赤いアイコン)か、 編集画面にある削除ボタン(画面の下にあります)をクリックします。

登録した情報を表示する

登録したスタッフ情報は、一覧表示画面と個別表示画面で出力できます。URLは以下の通りです。 なお、スマートURLはオンの状態になっています。

一覧表示(index)

http://baserCMSの設置URL/cast/casts/index

なおURLの末尾にカテゴリIDを付与することで、特定のカテゴリの一覧表示を出力できます。 例えば基本カテゴリID「2」の一覧を表示する場合は

http://baserCMSの設置URL/cast/casts/index/2

となります。またさらにその後ろに、職能カテゴリIDを付与することで、一覧表示を絞り込むことができます。 例えば基本カテゴリID「2」の中にある職能カテゴリ「4」の一覧は

http://baserCMSの設置URL/cast/casts/index/2/4

となります。なお、基本カテゴリは無条件で職能カテゴリだけで絞り込む場合は、基本カテゴリ部分に「0」を与えて下さい。 例えば職能カテゴリ「4」だけで一覧を表示する場合は以下のようになります。

http://baserCMSの設置URL/cast/casts/index/0/4

個別表示(view)

http://baserCMSの設置URL/cast/casts/view/(登録データのNo)

なお表示する際に使用できるコンテンツテンプレートについては後述しておりますので、 そちらをご参照ください。コンテンツテンプレート内で使用できるヘルパー(テンプレートタグ)については、次項でご紹介しています。

専用ヘルパー(テンプレートタグ)

本プラグインでは、登録データを出力するための専用ヘルパーを実装しています。

$this->Cast->fullName($cast, $link, $option)
スタッフの名前を出力します。
$cast
スタッフ情報です。デフォルトテンプレートのループ内では$castと記述すれば動きます。
$link
初期値はfalse。出力した名前に個別表示へのリンクをはるかどうか設定できます。
$options
リンクに関するオプションを配列で指定できます。
$this->Cast->fullRubi($cast, $link, $option)
スタッフ名のふりがなを出力します。
$cast
スタッフ情報です。デフォルトテンプレートのループ内では$castと記述すれば動きます。
$link
初期値はfalse。出力した名前(ふりがな)に個別表示へのリンクをはるかどうか設定できます。
$options
リンクに関するオプションを配列で指定できます。
$this->Cast->content($cast)
スタッフの紹介文を出力します。
$this->Cast->bloodType($cast)
スタッフの血液型を出力します。
$this->Cast->birthday($cast, $format)
スタッフの生年月日を出力します。
$cast
スタッフ情報です。デフォルトテンプレートのループ内では$castと記述すれば動きます。
$format
初期値は「Y年m月d日」。出力する生年月日のフォーマットを設定できます。
$this->Cast->category($cast)
スタッフの基本カテゴリ名を出力します。
$this->Cast->jobCategory($cast)
スタッフの職能カテゴリ名を出力します。
$this->Cast->nickname($cast)
スタッフのニックネームを出力します。
$this->Cast->image($cast, $number)
登録されている画像を出力します。第2引数には1〜4の整数値を入力し、画像1〜画像4のどれを出力するか指定します。
$this->Cast->otherField($cast, $number)
登録されている汎用項目(その他)を出力します。第2引数には1〜8の整数値を入力し、汎用項目1〜8のどれを出力するか指定します。
$this->Cast->castUrl($cast, $number)
登録されているURLを出力します。第2引数には1〜3の整数値を入力し、URL1〜3のどれを出力するか指定します。 なおリンクはつきませんので、必要に応じて$this->BcBaser->link()を併用してください。
$this->Cast->skilList($cast, $categoryId, $options)
登録されているスキルをリストタグで出力します。タグではなく配列で取得したい場合は後述の$this->Cast->skilData()を利用してください。
$cast
スタッフ情報です。デフォルトテンプレートのループ内では$castと記述すれば動きます。
$categoryId
初期値はnull。スキルカテゴリのidを入れることで、特定のスキルカテゴリに所属するスキルだけを表示できます。
$options
・class
リストタグに付与するクラス名を指定できます。
・id
リストタグに付与するID名を指定できます。
$this->Cast->skilData($cast, $categoryId)
登録されているスキルを配列で返します。
$cast
スタッフ情報です。デフォルトテンプレートのループ内では$castと記述すれば動きます。
$categoryId
初期値はnull。スキルカテゴリのidを入れることで、特定のスキルカテゴリに所属するスキルだけを取得できます。
$this->Cast->age($cast)
登録された生年月日から年齢を計算して出力します。(ver.0.9.1以降)

コンテンツテンプレート

コンテンツテンプレートとは、 「ある特定の機能を持ったページ(コンテンツ)のデザインやレイアウトを指定するテンプレート」のことです。

例えばブログのコンテンツテンプレートなら、「一覧表示のページ」「個別の記事表示ページ」などを司るファイルがありますし、 メールフォームだと「入力画面のページ」「確認画面のページ」「送信後のページ」を司るファイルがあります。

同じように、本プラグインでもコンテンツテンプレートが必要になります。「一覧表示画面(index.php)」「個別表示画面(view.php)」の2ファイルです。

本プラグインのコンテンツテンプレートは、上の2ファイルをひとまとめにした「フォルダ単位」で構成されます。 1つのフォルダの中に「index.php」「view.php」の2ファイルを入れるというわけです。このフォルダを規定の場所(下記)に設置することで、管理画面から認識できるようになります。例えば「test」というフォルダ名でコンテンツテンプレートを作成する場合、次のようなフォルダ構造になります。

  /app/webroot/theme/(お使いのテーマ)/Casts/test/

おわりに

いかがでしたでしょうか。本プラグインはまだまだ開発途中であり、今後も色々な機能実装を検討しています。 ご意見・ご感想。バグの報告などございましたら、お気軽にお問い合せ下さい。

今後とも株式会社ヒニアラタを何卒宜しくお願い致します。