PHP 7.0.6 Released

Serialização de Objetos - objetos em sessão

A função serialize() retorna uma string contendo uma representação byte-stream de qualquer valor que pode ser armazenado pelo PHP. A função unserialize() pode utilizar essa string para recriar os valores originais da variável. Utilizar a serialização para salvar um objeto, salvará todas as variáveis de um objeto. Os métodos de um objeto não serão salvos, apenas o nome da classe.

Para deserializar um objeto com a função unserialize(), a classe deste objeto precisar estar definida. Isto é, se possuir um objeto da classe A e serializá-lo, você obterá uma string que referencia a classe A e contêm todos os valores de variáveis contidas nele. Se deseja-se deserializar este em outro arquivo, um objeto da classe A, a definição da classe A deve estar presente neste arquivo. Isso pode ser feito, por exemplo, armazenando a definição da classe A em um arquivo, e incluí-lo, fazendo uso da função 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);
  
// store $s somewhere where page2.php can find it.
  
file_put_contents('store'$s);

// page2.php:

  // this is needed for the unserialize to work properly.
  
include("classa.inc");

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

  
// now use the function show_one() of the $a object.
  
$a->show_one();
?>

Se uma aplicação estiver usando sessões e usar a função session_register() para registrar objetos, estes serão serializados automaticamente ao fim de cada página PHP, e serão deserializados automaticamente em cada uma das páginas seguintes. Isso significa que estes objetos podem aparecer em qualquer uma das páginas da aplicação, já que fazem parte da sessão. Entretanto, a função session_register() foi removida no PHP 5.4.0.

É fortemente recomendado que, quando uma aplicação serializa seus objetos, para uso posterior na aplicação, esta inclua a definição da classe do objeto em questão ao longo de toda aplicação. Não fazer isso pode resultar em objetos serem deserializados sem a definição da classe, que acarretará no PHP entregar um objeto da classe __PHP_Incomplete_Class_Name, que não possui métodos, tornando o objeto inútil.

Então, se, no exemplo anterior, $a se tornou parte da sessão ao executar session_register("a"), deve-se incluir o arquivo classa.inc em todas suas páginas, e não somente em page1.php e page2.php.

Além dos conselhos acima, note que pode-se capturar os eventos de serialização e deserialização de um objeto usando os métodos __sleep() e __wakeup(). Usar o método __sleep() também lhe permitirá serializar somente subconjuntos de propriedades de um objeto.

add a note add a note

User Contributed Notes 5 notes

up
109
php at lanar dot com dot au
6 years ago
Note that static members of an object are not serialized.
up
7
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
1
Harshwardhan (iamsmart9900 at gmail dot com)
6 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
-7
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.
up
-150
wbcarts at juno dot com
6 years ago
PHP OBJECT SERIALIZATION

I use a database to store info rather than storing PHP Objects themselves. However, I find that having a PHP Object acting as an interface to my db is way useful. For example, suppose I have a TABLE called 'user' that looks like this.

CREATE TABLE user {
  user_id MEDIUMINT UNSIGNED NOT NULL AUTO_INCREMENT,
  user_first VARCHAR(24) NOT NULL,
  user_last VARCHAR(24) NOT NULL,
  PRIMARY KEY (user_id)
);

Then I would create a PHP Class definition like so:

<?php

require('includes/db_connect.php');

class
User
{
  protected
$user_id;
  protected
$user_first;
  protected
$user_last;

  public function
__construct($id, $first, $last)
  {
   
$this->user_id = $id;
   
$this->user_first = $first;
   
$this->user_last = $last;
  }

 
# FUNCTIONS TO RETRIEVE INFO - DESERIALIZE.
 
public static function db_user_by_id($dbc, $id)
  {
   
$query = "SELECT * FROM user WHERE user_id=$id LIMIT 1";
    return
User::db_select($dbc, $query);
  }

  public static function
db_user_by_name($dbc, $first, $last)
  {
   
$query = "SELECT * FROM user WHERE user_first='$first' AND user_last='$last' LIMIT 1";
    return
User::db_select($dbc, $query);
  }

  protected static function
db_select($dbc, $query);
  {
   
$result = mysqli_query($dbc, $query);
    if(
mysqli_num_rows($result) > 0)
    {
     
$row = mysqli_fetch_array($result, MYSQLI_NUM);
      return new
User($row[0], $row[1], $row[2]);
    }
  }

 
# FUNCTIONS TO SAVE INFO - SERIALIZE.
 
public function insert($dbc)
  {
   
$query = "INSERT INTO user VALUES (NULL, '$this->user_first', '$this->user_last')";
   
$result = mysqli_query($dbc, $query);
  }

  public function
update($dbc)
  {
   
$query = "UPDATE user SET user_first='$this->user_first', user_last='$this->user_last' WHERE user_id=$this->id LIMIT 1";
   
$result = mysqli_query($dbc, $query);
  }

 
# GETTER and SETTER FUNCTIONS - DO NOT ALLOW SETTING OF ID
 
public function getId() {return $this->user_id;)
  public function
getFirst() {return $this->user_first;)
  public function
getLast() {return $this->user_last;)
  public function
setFirst($first) {$this->user_first = $first;}
  public function
setLast($last) {$this->user_last = $last;}

 
# CUSTOM FUNCTIONS
 
public function getFullName() {return $this->user_first . ' ' . $this->user_last;}
  public function
getLastFirst() {return $this->user_last . ', ' . $this->user_first;}
}

?>

Using PHP Objects for SERIALIZATION and DESERIALIZATION is now super-easy, for example:

<?php

require('User.php');

// INSERT a new user.
$user = new User(0, 'Frank', 'American');
$user->insert($dbc);  // done!

// UPDATE an existing user.
$user = User::db_user_by_id($dbc, 223);
$user->setFirst('Johnny');
$user->update($dbc);  // done!

mysqli_close($dbc);

?>
To Top