CakePHP3 Tips – ページ 3 – CakePHP3歴 1年のWEBエンジニアの備忘メモです。ブログ内容はCakePHP3.5 (PHP7.1) で検証しています。

2017/12/01 -jQuery3
Ajax, cache, response, timeout, サンプルコード

jQuery3 Ajax通信のサンプルコードです。

// ex) カテゴリ追加
$(function(){
$.ajax({
url: '/add',  // リクエスト送信先URL
type: 'POST', // get or postメソッド
timeout: 2000, // タイムアウト時間をミリ秒で設定
cache: false,  // キャッシュ無効
data: {'category_name': category_name}, // サーバーに送信する値
dataType: 'json' // サーバーから返されるデータ型
}).done(function (response, textStatus, jqXHR) {
// サーバー側[php] echo json_encode(['status' => true or false]);
if (response.status) {
// 追加成功
alert('success.');
} else {
// 追加失敗
alert('error.');
}
}).fail(function (jqXHR, textStatus, errorThrown) {
// 通信失敗
alert('error.');
});
});

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

// ex) カテゴリ追加

$(function(){

$.ajax({

url: '/add', // リクエスト送信先URL

type: 'POST', // get or postメソッド

timeout: 2000, // タイムアウト時間をミリ秒で設定

cache: false, // キャッシュ無効

data: {'category_name': category_name}, // サーバーに送信する値

dataType: 'json' // サーバーから返されるデータ型

}).done(function (response, textStatus, jqXHR) {

// サーバー側[php] echo json_encode(['status' => true or false]);

if (response.status) {

// 追加成功

alert('success.');

} else {

// 追加失敗

alert('error.');

}

}).fail(function (jqXHR, textStatus, errorThrown) {

// 通信失敗

alert('error.');

});

CakePHP3 Ajax通信でコントローラーの途中で抜ける方法

2017/11/30 -コントローラー(Controller)
Ajax, autoRender, echo, json_encode, return

CakePHP3 Ajax通信でコントローラーの途中で抜ける方法の参考コードです。

public function index()
{
$this->autoRender = FALSE;
$flg = true; // true or false
if (!$flg) {
// Ajax戻り値
echo json_encode(['status' => false, 'err_msg' => __('サーバーエラーが発生しました。')]);
// ここで処理終了
return;
}
}

1

2

3

4

5

6

7

8

9

10

11

12

13

public function index()

{

$this->autoRender = FALSE;

$flg = true; // true or false

if (!$flg) {

// Ajax戻り値

echo json_encode(['status' => false, 'err_msg' => __('サーバーエラーが発生しました。')]);

// ここで処理終了

return;

}

CakePHP3 コントローラーでのtry-catch処理

2017/11/30 -コントローラー(Controller)
catch, Exception, try, エラー処理, 例外処理

CakePHP3 コントローラーでのtry-catch例外処理の参考コードです。

use Cake\Core\Exception\Exception; // Exceptionクラスインポート
class UsersController extends AppController
{
public function index()
{
try {
$flg = true; // true or false
if (!$flg) {
throw new Exception(); // 例外エラー投げる
}
echo 'OK';
} catch(Exception $e) {
echo 'NG';
}
}
}
// 「$flg==true」の場合
出力ログ: 'OK'
// 「$flg==false」の場合
出力ログ: 'NG'

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

use Cake\Core\Exception\Exception; // Exceptionクラスインポート

class UsersController extends AppController

{

public function index()

{

try {

$flg = true; // true or false

if (!$flg) {

throw new Exception(); // 例外エラー投げる

}

echo 'OK';

} catch(Exception $e) {

echo 'NG';

}

// 「$flg==true」の場合

出力ログ: 'OK'

// 「$flg==false」の場合

出力ログ: 'NG'

CakePHP3 トランザクション処理フロー

2017/11/29 -コントローラー(Controller)
ConnectionManager, データ整合性, トランザクション処理, ロールバック

CakePHP3 トランザクション(transaction)処理の流れです。 ※ 複数テーブル更新時などに使用(データ整合性を保つため) [crayon-5bee67a410cd3 …

CakePHP3 コントローラーでステータスコードを設定する方法

2017/11/29 -コントローラー(Controller)
Forbidden, NotFound, ステータスコード

CakePHP3 コントローラーでステータスコード(statusCode)を設定する方法です。

// 403 Forbidden
$this->response->statusCode(403);
// 404 Not Found
$this->response->statusCode(404);

1

2

3

4

5

// 403 Forbidden

$this->response->statusCode(403);

// 404 Not Found

$this->response->statusCode(404);

よく使うLinuxコマンドリスト【CentOS】

2017/11/29 -Linux
CentOS, free, ifconfig, Linuxコマンド, vmstat

◯ free: メモリーの使用状況を表示 [-m 容量をMバイト単位]

# free -m
total       used       free     shared    buffers     cached
Mem:          3830        525       3305         25         16        176
-/+ buffers/cache:        331       3498
Swap:          815          0        815

1

2

3

4

5

# free -m

total used free shared buffers cached

Mem: 3830 525 3305 25 16 176

-/+ buffers/cache: 331 3498

Swap: 815 0 815

◯ vmstat: メ …

PHP7 ディレクトリが存在しなければ作成する方法

2017/11/29 -PHP7
file_exists, mkdir, ディレクトリ

PHP7 ディレクトリが存在しなければディレクトリ作成する方法。

//　ディレクトリが存在しなければディレクトリ作成する
$target_path = '/var/www/html/cakephp3.com/logs/'.date('Ymd');
if (!file_exists($target_path)) {
mkdir($target_path);
}

1

2

3

4

5

//　ディレクトリが存在しなければディレクトリ作成する

$target_path = '/var/www/html/cakephp3.com/logs/'.date('Ymd');

if (!file_exists($target_path)) {

mkdir($target_path);

}

CakePHP3 本番環境用にデバッグモード無効にする方法

2017/11/29 -CakePHP3
DebugKit, デバッグモード, 本番環境

CakePHP3 本番環境用にデバッグモード無効(エラー・警告メッセージ非表示)にする方法。 ◯ 「config/app.php」ファイルの先頭行にあるdebug設定を変更する。 [cray …

CakePHP3 ログのパーミッション変更方法

2017/11/29 -CakePHP3
mask, パーミッション, ログ

CakePHP3 ログ(Log)のパーミッション変更方法です。 ◯ 「config/app.php」ファイルのLog定義に『mask』追記 ※ logs/debug.log&nbs …

CakePHP3 基本ディレクトリ構成

2017/11/29 -CakePHP3
ディレクトリ構成

CakePHP3の基本ディレクトリ構成(インストール直後)です。

├── bin               -- 実行コマンド
├── config            -- 設定ファイル
├── logs              -- ログ出力
├── plugins           -- プラグイン
├── src               -- 開発
│   ├── Console       
│   ├── Controller    -- コントローラー
│   │   └── Component -- コンポーネント
│   ├── Model         -- モデル
│   │   ├── Behavior  -- ビヘイビア
│   │   ├── Entity    -- エンティティ
│   │   └── Table     -- テーブル
│   ├── Shell         -- シェル
│   ├── Template      -- テンプレート
│   └── View
│       └── Helper    -- ヘルパー
├── tests             -- テスト関連
├── tmp               -- テンポラリ
├── vendor            -- 外部ライブラリ
└── webroot           -- WEB公開

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

├── bin -- 実行コマンド

├── config -- 設定ファイル

├── logs -- ログ出力

├── plugins -- プラグイン

├── src -- 開発

│ ├── Console

│ ├── Controller -- コントローラー

│ │ └── Component -- コンポーネント

│ ├── Model -- モデル

│ │ ├── Behavior -- ビヘイビア

│ │ ├── Entity -- エンティティ

│ │ └── Table -- テーブル

│ ├── Shell -- シェル

│ ├── Template -- テンプレート

│ └── View

│ └── Helper -- ヘルパー

├── tests -- テスト関連

├── tmp -- テンポラリ

├── vendor -- 外部ライブラリ

└── webroot -- WEB公開

CakePHP3 Sessionの保存先をDBに変更する方法

2017/11/29 -CakePHP3
database, session

CakePHP3 Sessionの保存先(php)をDBに変更する方法です。 ◯ セッション保存用のテーブル作成

CREATE TABLE sessions (
id char(40) NOT NULL,
data text,
expires INT(11) NOT NULL,
PRIMARY KEY  (id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

1

2

3

4

5

6

CREATE TABLE sessions (

id char(40) NOT NULL,

data text,

expires INT(11) NOT NULL,

PRIMARY KEY (id)

) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

◯&nbs …

CakePHP3 セッション(session)使い方

2017/11/29 -コントローラー(Controller)
destroy, getSession, read, session, write

CakePHP3 コントローラーでのセッション(session)の使い方です。

// ローカル変数にする
$session = $this->request->getSession();　// CakePHP 3.5~
$session = $this->request->session();　　　// CakePHP ~3.4
// セッション書き込み
$session->write('Config.language', 'ja');
// セッション読み込み
$session->read();　// 全て
$session->read('Config.language');　// キー指定
ex)
var_dump($session->read());　// array('Config' => array('time' => int 1511915063 , 'language' => string 'ja'))
var_dump($session->read('Config.language'));　// 'ja'
// セッション読み込み後に削除
$session->consume('Config.language');　// キー指定
ex)
var_dump($session->read());　// array('Config' => array('time' => int 1511915063 , 'language' => string 'ja'))
$session->consume('Config.language');
var_dump($session->read());　// array('Config' => array('time' => int 1511915063))
// セッション削除(キー指定)
$session->delete('Config.language');
// セッション破棄
$session->destroy();
// セッション存在確認(キー指定)
$session->check('Config.language'); // 存在する: true, 存在しない: false

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

// ローカル変数にする

$session = $this->request->getSession();　// CakePHP 3.5~

$session = $this->request->session();　　　// CakePHP ~3.4

// セッション書き込み

$session->write('Config.language', 'ja');

// セッション読み込み

$session->read();　// 全て

$session->read('Config.language');　// キー指定

ex)

var_dump($session->read());　// array('Config' => array('time' => int 1511915063 , 'language' => string 'ja'))

var_dump($session->read('Config.language'));　// 'ja'

// セッション読み込み後に削除

$session->consume('Config.language');　// キー指定

ex)

var_dump($session->read());　// array('Config' => array('time' => int 1511915063 , 'language' => string 'ja'))

$session->consume('Config.language');

var_dump($session->read());　// array('Config' => array('time' => int 1511915063))

// セッション削除(キー指定)

$session->delete('Config.language');

// セッション破棄

$session->destroy();

// セッション存在確認(キー指定)

$session->check('Config.language'); // 存在する: true, 存在しない: false

CakePHP3 ビューからエレメント(Element)に値渡す方法

2017/11/28 -ビュー(Template)
element, パラメーターアサイン

CakePHP3 ビューからエレメントに値渡す(パラメーターアサイン)方法です。 ※ エレメント(Element)：画面デザインのパーツを再利用できるように定義できる機能です。 [cray …

CakePHP3 コントローラーからビューに値渡す方法

2017/11/28 -コントローラー(Controller)
compact, htmlspecialchars, set, パラメーターアサイン

CakePHP3 コントローラーからビューに値渡す(パラメーターアサイン)方法です。 ◯ コントローラー側(Controller)

$test = 'xxx@cakephp3.com';
// パラメーターアサイン
$this->set('test', $test);
or
$this->set(compact('test')); // compact: 文字列をキーとして同じ文字列の変数を使用

1

2

3

4

5

$test = 'xxx@cakephp3.com';

// パラメーターアサイン

$this->set('test', $test);

or

$this->set(compact('test')); // compact: 文字列をキーとして同じ文字列の変数を使用

◯ …

特定の文字列を含むファイルを見つける (find・xargs・grep)

2017/11/28 -Linux
CentOS, find, grep, Linuxコマンド, xargs

個人的に非常によく使うLinuxコマンドです。特定の文字列を含むファイルを見つける方法(find・xargs・grep)。

find . -name "*" -type f | xargs grep "検索文字列"

1	find . -name "*" -type f \| xargs grep "検索文字列"

CakePHP3 GETメソッドのクエリストリングを取得する方法

2017/11/28 -コントローラー(Controller)
Get, getQuery, クエリストリング

CakePHP3 GETメソッドのクエリストリングを取得する方法です。

// 検証URL例
/users?email=xxx@cakephp3.com&password=xxx

1 2	// 検証URL例 /users?email=xxx@cakephp3.com&password=xxx

◯ 全クエリストリング取得 [crayon-5bee67a41 …

CakePHP3 テーブルオブジェクトをロードする方法

2017/11/28 -コントローラー(Controller)
TableRegistry, テーブルオブジェクト

◯ CakePHP3 コントローラーでテーブルオブジェクトをロードする方法です。

<?php
use Cake\ORM\TableRegistry; // TableRegistryクラスをインポート
class AppController extends Controller
{
public function index()
{
// テーブルオブジェクトロード(usersテーブル)
$obj_users = TableRegistry::get('users');
}
}

1

2

3

4

5

6

7

8

9

10

11

<?php

use Cake\ORM\TableRegistry; // TableRegistryクラスをインポート

class AppController extends Controller

{

public function index()

{

// テーブルオブジェクトロード(usersテーブル)

$obj_users = TableRegistry::get('users');

}

CakePHP3 DebugKitでSQLログを確認する方法

2017/11/28 -CakePHP3
DebugKit, SQLチューニング, SQLログ

CakePHP3 DebugKitでSQLログと実行速度を確認にする方法。 ※ フッターバーにあるDebugKitの『Sql Log』をクリックすると、実行SQLと実行速度(Took[ms] …

CakePHP3 DebugKitを非表示にする方法

2017/11/28 -CakePHP3
bootstrap, DebugKit

CakePHP3 DebugKit(デバッグキット)を非表示にする方法。 ◯ 「config/bootstrap.php」ファイルの最終行にあるDebugKit設定を変更する。 [crayo …

CakePHP3 フラッシュメッセージの設定・表示方法

2017/11/28 -CakePHP3
flash, テンプレート, フラッシュメッセージ

CakePHP3 デフォルトでフラッシュメッセージ用のテンプレートが３つ用意されています。

// デフォルトテンプレート
src/Template/Element/Flash/default.ctp
src/Template/Element/Flash/error.ctp
src/Template/Element/Flash/success.ctp
// default.ctp
# cat src/Template/Element/Flash/default.ctp
<?php
$class = 'message';
if (!empty($params['class'])) {
$class .= ' ' . $params['class'];
}
if (!isset($params['escape']) || $params['escape'] !== false) {
$message = h($message);
}
?>
<div class="<?= h($class) ?>" onclick="this.classList.add('hidden');"><?= $message ?></div>
// error.ctp
# cat src/Template/Element/Flash/error.ctp 
<?php
if (!isset($params['escape']) || $params['escape'] !== false) {
$message = h($message);
}
?>
<div class="message error" onclick="this.classList.add('hidden');"><?= $message ?></div>
// success.ctp
# cat src/Template/Element/Flash/success.ctp 
<?php
if (!isset($params['escape']) || $params['escape'] !== false) {
$message = h($message);
}
?>
<div class="message success" onclick="this.classList.add('hidden')"><?= $message ?></div>

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

// デフォルトテンプレート

src/Template/Element/Flash/default.ctp

src/Template/Element/Flash/error.ctp

src/Template/Element/Flash/success.ctp

// default.ctp

# cat src/Template/Element/Flash/default.ctp

<?php

$class = 'message';

if (!empty($params['class'])) {

$class .= ' ' . $params['class'];

}

if (!isset($params['escape']) || $params['escape'] !== false) {

$message = h($message);

}

?>

<div class="<?= h($class) ?>" onclick="this.classList.add('hidden');"><?= $message ?></div>

// error.ctp

# cat src/Template/Element/Flash/error.ctp

<?php

if (!isset($params['escape']) || $params['escape'] !== false) {

$message = h($message);

}

?>

// success.ctp

# cat src/Template/Element/Flash/success.ctp

<?php

if (!isset($params['escape']) || $params['escape'] !== false) {

$message = h($message);

}

?>

◯ フラッシュメッセージ設定(コントローラ …