CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

2017/12/01 2017/12/09

CakePHP3に「jQuery UI DatePicker」を実装

CakePHP3に「jQuery UI DatePicker」を実装する手順解説の前置き

　
日付を入力する項目に、カレンダーから日付を選択して日付を入力するインターフェイスを提供する「デイトピッカー」。
　
これを CakePHP3の入力画面に実装したい！ということで、その手順を解説します。
　
ちなみに、この記事では「jQuery UI DatePicker」を実装します。
　
　
実装するテーブルは「Topics」、
項目名は「topics_date」です。
　
「Topics」という「お知らせ」を入力する CMSの日付を入力する項目に、デイトピッカーを導入する、という想定です。
　
【Before】

　
【After】

　
　
jQuery UIの DatePickerは、以下のページにあります。
　http://jqueryui.com/datepicker/
　
　

CakePHP3に「jQuery UI DatePicker」を実装する手順

１．add.ctp、edit.ctpに DatePickerの処理を記述

　
まず最初に、DatePickerに関連する処理を記述します。
　
記述する対象ファイルは、以下です。
　/src/Template/Topics/add.ctp
　/src/Template/Topics/edit.ctp
　
下記のソースコードを追記します。
追記する箇所は、ファイルのどこでも OKですが、個人的には分かりやすさを優先して、ファイルの先頭に追記しています。
　

<?= $this->Html->css('//code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css',['block' => true]) ?>
<?= $this->Html->script('//code.jquery.com/jquery-1.12.4.js',['block' => true]) ?>
<?= $this->Html->script('//code.jquery.com/ui/1.12.1/jquery-ui.js',['block' => true]) ?>
<?= $this->Html->scriptStart(['block' => true]) ?>
  $( function() {
    $( "#datepicker" ).datepicker();
  } );
<?= $this->Html->scriptEnd() ?>

<?= $this->Html->css('//code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css',['block' => true]) ?>

<?= $this->Html->script('//code.jquery.com/jquery-1.12.4.js',['block' => true]) ?>

<?= $this->Html->script('//code.jquery.com/ui/1.12.1/jquery-ui.js',['block' => true]) ?>

<?= $this->Html->scriptStart(['block' => true]) ?>

$( function() {

$( "#datepicker" ).datepicker();

} );

<?= $this->Html->scriptEnd() ?>

　
　
また、実際にデイトピッカーを導入する項目である「topics_date」に、「ID」を設定します。
　

// デフォルト状態
echo $this->Form->control('topics_date');

// DatePickerの処理を追記した状態
echo $this->Form->control('topics_date',["type"=>"text","label"=>"日付","id"=>"datepicker"]);

// デフォルト状態

echo $this->Form->control('topics_date');

// DatePickerの処理を追記した状態

echo $this->Form->control('topics_date',["type"=>"text","label"=>"日付","id"=>"datepicker"]);

　
加えて、入力形式を「text」にして、ラベルを「日付」にする設定を加えています。
　
CakePHP3の FormHelperに関しては「CakePHP3のForm Helperの使い方のまとめ」に記事を書いていますので、あわせて参照してください。
　
　

２．default.ctpに jQueryを読み込む設定を記述

　
続けて、default.ctpに jQueryを読み込む設定を記述します。
　
記述する対象ファイルは、以下です。
　/src/Template/Layout/default.ctp
　
下記のソースコードを追記します。
追記する場所は、「<head>～</head>」の間です。
　

<?= $this->fetch('script') ?>

1	<?= $this->fetch('script') ?>

　
とはいえ、この記述は、CakePHP3のデフォルトテンプレートにはあらかじめ記述されていますので、すでに記述されている場合は「default.ctp」を変更する必要はありません。
　
　
これだけで、デイトピッカーを導入することができます！
controllerなどを修正する必要はありません。
　
　
詳細な解説をしていませんが、上記のサンプルの通りの処理を書くことで、JavaScriptはブロック化の処理によって、指定のページだけで読み込まれて実行されるようになります。
ブロック化の処理についての解説は「CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説」に記載しましたので、あわせてご確認ください。
　
　

jQuery UIのライブラリ、および、DatePickerのスクリプトを default.ctpに直接読み込む場合

　
前項の説明は、「add.ctp」「edit.ctp」にブロック化したスクリプトを記述し、それを「default.ctp」で読み込む、という処理になっています。
　
ですが、ほとんどのページで「DatePicker」を使うため、直接「default.ctp」に書きたい、という場合は、「default.ctp」に下記の処理を追記します。
　

<?= $this->Html->css('//code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css') ?>
<?= $this->Html->script('//code.jquery.com/jquery-1.12.4.js') ?>
<?= $this->Html->script('//code.jquery.com/ui/1.12.1/jquery-ui.js') ?>
<?= $this->Html->scriptStart() ?>
  $( function() {
    $( "#datepicker" ).datepicker();
  } );
<?= $this->Html->scriptEnd() ?>

<?= $this->Html->css('//code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css') ?>

<?= $this->Html->script('//code.jquery.com/jquery-1.12.4.js') ?>

<?= $this->Html->script('//code.jquery.com/ui/1.12.1/jquery-ui.js') ?>

<?= $this->Html->scriptStart() ?>

$( function() {

$( "#datepicker" ).datepicker();

} );

<?= $this->Html->scriptEnd() ?>

　
「,[‘block’ => true])」の部分がなくなっていますが、それ以外は同じになります。
　
　

CakePHP3に実装した「jQuery UI DatePicker」のカスタマイズ、および、詳細解説

　
「jQuery UI DatePicker」の導入そのものは、上記に書いた箇所を追記することで実装することは可能です。
　
ただ、もう少し便利に使うため、理解を深めるために、カスタマイズの方法と実装方法の詳細解説を行います。
　
　

jQueryをダウンロードして利用する

　
先にも書いていた下記のサンプルソースは、「jquery.com」にある jQueryのライブラリをそのまま利用することを想定しています。
　
記述する対象ファイルは、以下です。
　/src/Template/Topics/add.ctp
　/src/Template/Topics/edit.ctp
　

<?= $this->Html->script('//code.jquery.com/jquery-1.12.4.js',['block' => true]) ?>
<?= $this->Html->script('//code.jquery.com/ui/1.12.1/jquery-ui.js',['block' => true]) ?>

1 2	<?= $this->Html->script('//code.jquery.com/jquery-1.12.4.js',['block' => true]) ?> <?= $this->Html->script('//code.jquery.com/ui/1.12.1/jquery-ui.js',['block' => true]) ?>

　
　
ですが、jQueryのライブラリをダウンロードしてサーバ内に設置したい場合は、下記の様に記述します。
　

<?= $this->Html->script('jquery-1.12.4',['block' => true]) ?>
<?= $this->Html->script('jquery-ui',['block' => true]) ?>

1 2	<?= $this->Html->script('jquery-1.12.4',['block' => true]) ?> <?= $this->Html->script('jquery-ui',['block' => true]) ?>

　
ダウンロードした jQueryのライブラリは「/webroot/js」の中に入れます。
　
　
もし、「/webroot/js」とは違う場所に入れたい場合は、下記の様にパスも含めて記述します。
　

<?= $this->Html->script('/otherdir/jquery-1.12.4',['block' => true]) ?>

1	<?= $this->Html->script('/otherdir/jquery-1.12.4',['block' => true]) ?>

　
　
HtmlHelperの詳細は、下記のオフィシャルサイトを参照してください。
https://book.cakephp.org/3.0/ja/views/helpers/html.html#javascript
　
　
ちなみに、HtmlHelperを利用する理由は、環境が変わった時にも柔軟に対応できるようにするためです。
そのため、「まずは動作させたい」という場合などは、下記の様に直接記述する方法でも問題ありません。
　

<script src="//code.jquery.com/jquery-1.12.4.js"></script>
<script src="//code.jquery.com/ui/1.12.1/jquery-ui.js"></script>

1 2	<script src="//code.jquery.com/jquery-1.12.4.js"></script> <script src="//code.jquery.com/ui/1.12.1/jquery-ui.js"></script>

デイトピッカーのテーマ（カラー）を変更する

　
デイトピッカーだけではありませんが、jQuery UIにはあらかじめテーマが用意されています。
　
先に紹介した、下記のサンプルソースは「base」というテーマを使用しています。
下記の URL内にある「base」がテーマの指定です。
　
記述する対象ファイルは、以下です。
　/src/Template/Topics/add.ctp
　/src/Template/Topics/edit.ctp
　

<?= $this->Html->css('//code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css',['block' => true]) ?>

1	<?= $this->Html->css('//code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css',['block' => true]) ?>

　
　
これをサイトのデザインにあったものに変更したい場合は、下記の jQueryのテーマのページからテーマの名前を確認します。
http://jqueryui.com/themeroller/
　

　
このテーマのリストの中から「UI lightness」を選択する場合は、大文字を小文字にして、スペースを「-（ハイフン）」でつないだ「ui-lightness」を指定します。
　

<?= $this->Html->css('//code.jquery.com/ui/1.12.1/themes/ui-lightness/jquery-ui.css',['block' => true]) ?>

1	<?= $this->Html->css('//code.jquery.com/ui/1.12.1/themes/ui-lightness/jquery-ui.css',['block' => true]) ?>

　
　
「Roll Your Own」を利用すれば、より自由なデザインを実装することも可能です。
　
　

jQuery UI DatePickerのカレンダーの表示を日本語化する

　
jQuery UI DatePickerのカレンダーの表示は、デフォルトでは英語表記です。
これは、前項のテーマを変更しても変わりません。
　
というわけで、カレンダーを日本語化する方法の解説です。
　
まず、下記のサイト（公式の GitHubリポジトリ）から日本語化ファイル「datepicker-ja.js」をダウンロードします。
https://github.com/jquery/jquery-ui/blob/master/ui/i18n/datepicker-ja.js
　
画面の「Raw」のリンクを右クリックして、ファイルに保存すれば OKです。
　
ダウンロードしたファイルは「/webroot/js」の中に入れます。
　
そして、ファイルを呼び出す処理を記述します。
　
記述する対象ファイルは、以下です。
　/src/Template/Topics/add.ctp
　/src/Template/Topics/edit.ctp
　
下記のソースコードを追記します。
　

<?= $this->Html->script('datepicker-ja.js',['block' => true]) ?>

1	<?= $this->Html->script('datepicker-ja.js',['block' => true]) ?>

　
これで、下記の様に日本語になります。

　
　

選択した日付の表記を「2017/12/24」に変更する

　
jQuery UI DatePickerで、カレンダーを選択した場合のデフォルトの表記は「12/24/2017」のようになっています。
　
これを日本で一般的な表記である「2017/12/24」「2017-12-24」の表記にするには、下記の様に記述します。
　
記述する対象ファイルは、以下です。
　/src/Template/Topics/add.ctp
　/src/Template/Topics/edit.ctp
　

<?= $this->Html->scriptStart(['block' => true]) ?>
  $( function() {
    $( "#datepicker" ).datepicker({
      dateFormat: 'yy/mm/dd'
    });
  } );
<?= $this->Html->scriptEnd() ?>

<?= $this->Html->scriptStart(['block' => true]) ?>

$( function() {

$( "#datepicker" ).datepicker({

dateFormat: 'yy/mm/dd'

});

} );

<?= $this->Html->scriptEnd() ?>

　
最初のサンプルとは 3～5行目が変更されています。
上記では「2017/12/24」の表記になりますが、他の表記を希望する場合は 4行目の記述の部分を変更してみてください。
　
　
ちなみに、前の項目の日本語化スクリプトを利用している場合は、日本語化処理の中で「2017/12/24」の表記になりますので、このカスタマイズは必要なくなります。
　
　

更新画面で表示される日付の表記「2017/12/24」に変更する

　
カレンダーを選択した際に表示される表記を変更する方法は、前項で説明したとおりです。
　
ですが、それだけでは更新画面で画面を表示した際に表示される表記は「12/24/17」のようになっています。
　
これを「2017/12/24」のように変更する方法です。
　
下記の 2つの方法は、デイトピッカーとは関係なく、また、無理やり感がある方法ですので、もっとスマートな方法もあるように感じます。
もしくは、JavaScriptで置換する方法も採れるであろうと思います。
　
記述する対象ファイルは、以下です。
　/src/Template/Topics/edit.ctp
　

$topic["topics_date"] = $topic["topics_date"] ? $topic["topics_date"]->i18nFormat('yyyy-MM-dd') : "";
echo $this->Form->control('topics_date',["type"=>"text","label"=>"日付","id"=>"datepicker"]);

1 2	$topic["topics_date"] = $topic["topics_date"] ? $topic["topics_date"]->i18nFormat('yyyy-MM-dd') : ""; echo $this->Form->control('topics_date',["type"=>"text","label"=>"日付","id"=>"datepicker"]);

$topic["topics_date"] = ;
echo $this->Form->control('topics_date',["type"=>"text","label"=>"日付","id"=>"datepicker","value"=>$topic["topics_date"] ? $topic["topics_date"]->i18nFormat('yyyy-MM-dd') : ""]);

1 2	$topic["topics_date"] = ; echo $this->Form->control('topics_date',["type"=>"text","label"=>"日付","id"=>"datepicker","value"=>$topic["topics_date"] ? $topic["topics_date"]->i18nFormat('yyyy-MM-dd') : ""]);

　
CakePHP3で日付項目のフォーマットを指定する方法は、下記に解説がしてあります。
https://book.cakephp.org/3.0/ja/core-libraries/time.html#id3
　
　

その他の、jQuery UI DatePickerのカスタマイズ方法

　
その他の、jQuery UI DatePickerのカスタマイズ方法、例えば、

表示するカレンダーを当月分だけではなく、2カ月、3カ月と増やす方法
選択できる日付を制限する方法
年、月の選択をプルダウンで選択できるようにする方法

など、より望んでいるインターフェイスに変更する方法は、下記にまとめましたので、あわせて参考にしてください。
jQuery UI DatePickerの導入の方法。および、カスタマイズ方法の解説
 jQuery UI DatePickerに時間を入力できる機能を追加する方法解説
　
　

CakePHP3のブロック化を利用した WYSIWYGエディタの導入方法

　
入力フォームに導入する仕組みとして、デイトピッカーと同じくらいの頻度で導入することがある WYSIWYGエディタについても記事を書いています。
CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説
　
ここで解説をしたブロック化の仕組みを利用した導入方法の解説です。
　
また、WYSIWYGエディタとしては、CKEditor4、CKEditor5を利用して解説をしています。
そもそもの CKEditor4、CKEditor5の導入方法、カスタマイズの方法については下記の記事を参考にしてください。
WYSIWYGエディタのCKEditor 4を設置、カスタマイズ、日本語化の方法を解説
 WYSIWYGエディタのCKEditor 5を設置、カスタマイズ、日本語化の方法を解説
　
　

- CakePHP 3.x 4.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつ、テンプレートファイル、設定情報ファイルの場所とそれらをカスタマイズする方法を説明します。

: CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で動的に表示件数を変える方法です。

: CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応

CakePHP3で検索を担うプラグイン「friendsofcake/search」の紹介。基本的な設置方法の紹介のほか、処理の記述方法のバリエーション、エラーの解説など。CakeDC/searchより導入は簡単！

: CakePHP3のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）

CakePHP3の英語のメッセージを日本語化（多言語化）する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。

: CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定

CakePHP3の Authコンポーネントや CakeDC/Usersプラグインなどを利用したユーザ管理・認証システムにおいて、ログインしていなくても見ることができるページの設定方法を解説。

: CakePHP 2.3　Search Pluginで検索処理　その４前方一致検索、後方一致検索、不等号による検索、between句による範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で前方一致検索、後方一致検索、不等号による検索、between句による範囲検索の解説です。

: CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応

CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。

: CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()

CakePHP4でデフォルトのレイアウトファイル「default.php」は管理側に使用し、これとは別のデザインを公開側のページに設定したい、を実装する方法を解説。

: CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

: CakePHP3でQRコードを作成、表示するライブラリ「cakePHP-QR-Code-Helper」

CakePHPでQRコードを生成するライブラリ「cakePHP-QR-Code-Helper」の紹介。GDライブラリのインストールも必要ないHelperとして提供されているため、ファイルを設置すればすぐに使用可能。