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

投稿日：2017年11月29日更新日：2018年3月22日

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

// ローカル変数にする

$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

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

執筆者：管理人

comment コメントをキャンセル

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください。

: CakePHP3 ImageMagickでExifのOrientation情報あったら写真回転する
◯ CakePHP3 ImageMagickでExifのOrientation情報あったら写真回転する方法(JPEGのみ)。 [crayon-6508ed7a40016647337 …

CakePHP3 コントローラーにてURL生成(Router)する方法

◯ CakePHP3 コントローラーにてURL生成(Router)方法

<?php
use Cake\Routing\Router;
//// アクセスURL例:https://test.com/contact?test
// カレントパス(ドメイン含む)
Router::url(NULL, true);
-> https://test.com/contact
// カレントパスのみ(ドメイン含まない)
Router::url();
-> /contact
// クエリストリングを含むパス(ドメイン含む)
Router::reverse($this->request,　true);
-> https://test.com/contact?test
// クエリストリングを含むパス(ドメイン含まない)
Router::reverse($this->request);
-> /contact?test
// 【その他】　サーバー変数($_SERVER)
$_SERVER['REQUEST_URI'];
-> /contact?test

<?php

use Cake\Routing\Router;

//// アクセスURL例:https://test.com/contact?test

// カレントパス(ドメイン含む)

Router::url(NULL, true);

-> https://test.com/contact

// カレントパスのみ(ドメイン含まない)

Router::url();

-> /contact

// クエリストリングを含むパス(ドメイン含む)

Router::reverse($this->request,　true);

-> https://test.com/contact?test

// クエリストリングを含むパス(ドメイン含まない)

Router::reverse($this->request);

-> /contact?test

// 【その他】　サーバー変数($_SERVER)

$_SERVER['REQUEST_URI'];

-> /contact?test

CakePHP3 デフォルトレイアウト(default.ctp)の変更方法

CakePHP3 デフォルトレイアウト(default.ctp)の変更方法です。

class UsersController extends AppController
{
public function index()
{
// レイアウト変更
//  変更前「src/Template/Layout/default.ctp」
//  変更後「src/Template/Layout/test.ctp」
// CakePHP ~3.3
$this->viewBuilder()->layout('test');
// CakePHP 3.4~
$this->viewBuilder()->setLayout('test'); 
}
}

class UsersController extends AppController

{

public function index()

{

// レイアウト変更

// 変更前「src/Template/Layout/default.ctp」

// 変更後「src/Template/Layout/test.ctp」

// CakePHP ~3.3

$this->viewBuilder()->layout('test');

// CakePHP 3.4~

$this->viewBuilder()->setLayout('test');

}

コントローラーから例外エラー(404・500)を投げる

コントローラーから例外エラー(404・500)を投げる方法。

<?php
namespace App\Controller;
use Cake\Network\Exception\NotFoundException; // 404エラー用クラス
use Cake\Network\Exception\InternalErrorException; // 500エラー用クラス
class AppController extends Controller
{
public function index($id=null)
{
$article = $this->Articles->findById($id)->first();
if (empty($id)) {
throw new InternalErrorException; // 500エラー投げる(ここで処理終了)
} else if (empty($article)) {
throw new NotFoundException(__('記事が見つかりません')); // 404エラー投げる(ここで処理終了)
}
}
}

<?php

namespace App\Controller;

use Cake\Network\Exception\NotFoundException; // 404エラー用クラス

use Cake\Network\Exception\InternalErrorException; // 500エラー用クラス

class AppController extends Controller

{

public function index($id=null)

{

$article = $this->Articles->findById($id)->first();

if (empty($id)) {

throw new InternalErrorException; // 500エラー投げる(ここで処理終了)

} else if (empty($article)) {

throw new NotFoundException(__('記事が見つかりません')); // 404エラー投げる(ここで処理終了)

}

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

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'