ConFoo Montreal 2017 Calling for Papers

オブジェクトのシリアライズ

オブジェクトのシリアライズ - セッション内でのオブジェクト

serialize() は、 PHP で保存できるあらゆる値をバイトストリームで表した文字列を返します。 unserialize() を使うと、 この文字列から元の変数の値を取り出すことができます。 オブジェクトをシリアライズすると、オブジェクト内の変数もすべて保存されます。 オブジェクト内のメソッドは保存されません。 クラス名のみが保存されます。

オブジェクトを unserialize() するには、 そのオブジェクトのクラスが定義されている必要があります。 A クラスのオブジェクトをシリアライズしたのなら、 その文字列にはクラス A とその中のすべての変数の値が含まれています。 別のファイルでそれを復元してクラス A のオブジェクトを取り出すには、 まずそのファイル内にクラス A の定義が存在しなければなりません。 これを実現するには、たとえばクラス A の定義を別ファイルに書き出してそれを include したり spl_autoload_register() 関数を使ったりします。

<?php
// classa.inc:
  
  
class {
      public 
$one 1;
    
      public function 
show_one() {
          echo 
$this->one;
      }
  }
  
// page1.php:

  
include("classa.inc");
  
  
$a = new A;
  
$s serialize($a);
  
// $s を、page2.php からみつけられるどこかに書き出します
  
file_put_contents('store'$s);

// page2.php:
  
  // シリアライズした文字列を復元するには、これが必要です
  
include("classa.inc");

  
$s file_get_contents('store');
  
$a unserialize($s);

  
// これで、$a オブジェクトの show_one() が使えるようになりました
  
$a->show_one();
?>

セッションを使っているアプリケーションで session_register() を使ってオブジェクトを登録した場合は、 PHP のページの終了時にオブジェクトが自動的にシリアライズされます。 そして、次のページが始まるときに自動的にそれが復元されるのです。 これによって、いちどセッションに登録したオブジェクトは アプリケーションのどのページでも使えるようになります。 しかし session_register() 関数は PHP 5.4.0 で削除されます。

アプリケーション内でオブジェクトをシリアライズして再利用する場合のお勧めは、 そのクラスの定義をアプリケーション全体で include することです。 クラスの定義が存在しなければオブジェクトの復元に失敗してしまいます。 その場合、PHP は __PHP_Incomplete_Class_Name クラスのオブジェクトを返します。このオブジェクトにはメソッドは一切なく、 使い道がなくなってしまいます。

つまり、もし上の例の $asession_register("a") でセッションに格納するなら、 page1.phppage2.php だけではなく すべてのページで classa.inc を include しなければなりません。

ここまでで説明した以外の方法として、オブジェクトのシリアライズや復元のイベントを __sleep() メソッドと __wakeup() メソッドでフックすることができます。 __sleep() を使うと、 オブジェクトの一部のプロパティだけをシリアライズすることもできます。

add a note add a note

User Contributed Notes 4 notes

up
121
php at lanar dot com dot au
6 years ago
Note that static members of an object are not serialized.
up
14
michael at smith-li dot com
1 year ago
Reading this page you'd be left with the impression that a class's `serialize` and `unserialize` methods are unrelated to the `serialize` and `unserialize` core functions; that only `__sleep` and `__unsleep` allow you to customize an object's serialization interface. But look at http://php.net/manual/en/class.serializable.php and you'll see that there is a more straightforward way to control how a user-defined object is serialized and unserialized.
up
-6
Harshwardhan (iamsmart9900 at gmail dot com)
10 months ago
class UnSerializer {

    public function __construct($filename_with_path) { /* Input the Filename  */
        $this->filename = $filename_with_path;
        if ($this->filename == true) {
            return true;
        } else {
            echo 'File Name Error';
        }
    }

    public function check_file_validity() {
        $this->validity = file_exists($this->filename);
        if ($this->validity == true) {
            return true;
        } else {
            echo 'File Not Found !';
        }
    }

    public function getting_file_content() {
        if ($this->validity == true) {
            $this->content = file_get_contents($this->filename);
            if ($this->content == true) {
                return true;
            } else {
                echo 'We Can\'t Reach to the Data';
            }
        } else {
            echo 'File Not Found !';
        }
    }

    public function get_unserial_data() {
        $this->check_file_validity();
        $this->getting_file_content();
        if (!is_null($this->content)) {
            $this->unserializedval = unserialize($this->content);
            if ($this->unserializedval == true) {
                return true;
            }
        } else {
            echo 'We Can\'t Reach to the Data';
        }
    }

    public function get_unserialized_value() {
        return $this->unserializedval;
    }

}

$object = new UnSerializer('example_directory/filename'); /* Enter file name */
$object->get_unserial_data();
var_dump($object->get_unserialized_value());
up
-10
mjdragonexpert23 at gmail dot com
1 year ago
It is important to note that you cannot use the following characters in any array that gets serialized or deserializing will fail: single quote, double quote, colon, or semicolon.  To get around this, use the base64_encode function after using serialize when you save the data.  When you need to unserialize use the base64_decode function first then unserialize.
To Top