Module: PHP

Defined in:
lib/vendor/serialize.rb,
lib/vendor/unserialize.rb

Overview

PHP serialize() and unserialize() workalikes

First Released: 2003-06-02 (1.0.0)
Prev Release: 2003-06-16 (1.0.1), by Thomas Hurst <tom@hur.st>
This Release: 2004-09-17 (1.0.2), by Thomas Hurst <tom@hur.st>
              Switch all {}'s to explicit Hash.new's.

These two methods should, for the most part, be functionally identical
to the respective PHP functions;
 http://www.php.net/serialize, http://www.php.net/unserialize

string = PHP.serialize(mixed var[, bool assoc])
 Returns a string representing the argument in a form PHP.unserialize
 and PHP's unserialize() should both be able to load.

 Array, Hash, Fixnum, Float, True/FalseClass, NilClass, String and Struct
 are supported; as are objects which support the to_assoc method, which
 returns an array of the form [['attr_name', 'value']..].  Anything else
 will raise a TypeError.

 If 'assoc' is specified, Array's who's first element is a two value
 array will be assumed to be an associative array, and will be serialized
 as a PHP associative array rather than a multidimensional array.

mixed = PHP.unserialize(string serialized, [hash classmap, [bool assoc]])
 Returns an object containing the reconstituted data from serialized.

 If a PHP array (associative; like an ordered hash) is encountered, it
 scans the keys; if they're all incrementing integers counting from 0,
 it's unserialized as an Array, otherwise it's unserialized as a Hash.
 Note: this will lose ordering.  To avoid this, specify assoc=true,
 and it will be unserialized as an associative array: [[key,value],...]

 If a serialized object is encountered, the hash 'classmap' is searched for
 the class name (as a symbol).  Since PHP classnames are not case-preserving,
 this *must* be a .capitalize()d representation.  The value is expected
 to be the class itself; i.e. something you could call .new on.

 If it's not found in 'classmap', the current constant namespace is searched,
 and failing that, a new Struct(classname) is generated, with the arguments
 for .new specified in the same order PHP provided; since PHP uses hashes
 to represent attributes, this should be the same order they're specified
 in PHP, but this is untested.

 each serialized attribute is sent to the new object using the respective
 {attribute}=() method; you'll get a NameError if the method doesn't exist.

 Array, Hash, Fixnum, Float, True/FalseClass, NilClass and String should
 be returned identically (i.e. foo == PHP.unserialize(PHP.serialize(foo))
 for these types); Struct should be too, provided it's in the namespace
 Module.const_get within unserialize() can see, or you gave it the same
 name in the Struct.new(<structname>), otherwise you should provide it in
 classmap.

Note: StringIO is required for unserialize(); it’s loaded as needed

Class Method Summary collapse

Class Method Details

.serialize(var, assoc = false) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/vendor/serialize.rb', line 84

def self.serialize(var, assoc = false)
  s = ''
  case var
    when Array
      s << "a:#{var.size}:{"
      if assoc and var.first.is_a?(Array) and var.first.size == 2
        var.each { |k,v|
          s << PHP.serialize(k) << PHP.serialize(v)
        }
      else
        var.each_with_index { |v,i|
          s << "i:#{i};#{PHP.serialize(v)}"
        }
      end

      s << '}'

    when Hash
      s << "a:#{var.size}:{"
      var.each do |k,v|
        s << "#{PHP.serialize(k)}#{PHP.serialize(v)}"
      end
      s << '}'

    when Struct
      # encode as Object with same name
      s << "O:#{var.class.to_s.length}:\"#{var.class.to_s.downcase}\":#{var.members.length}:{"
      var.members.each do |member|
        s << "#{PHP.serialize(member)}#{PHP.serialize(var[member])}"
      end
      s << '}'

    when String
      s << "s:#{var.length}:\"#{var}\";"

    when Fixnum # PHP doesn't have bignums
      s << "i:#{var};"

    when Float
      s << "d:#{var};"

    when NilClass
      s << 'N;'

    when FalseClass, TrueClass
      s << "b:#{var ? 1 :0};"

    else
      if var.respond_to?(:to_assoc)
        v = var.to_assoc
        # encode as Object with same name
        s << "O:#{var.class.to_s.length}:\"#{var.class.to_s.downcase}\":#{v.length}:{"
        v.each do |k,v|
          s << "#{PHP.serialize(k.to_s)}#{PHP.serialize(v)}"
        end
        s << '}'
      else
        raise TypeError, "Unable to serialize type #{var.class}"
      end
  end

end

.unserialize(string, classmap = nil, assoc = false) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/vendor/unserialize.rb', line 84

def self.unserialize(string, classmap = nil, assoc = false)
  require 'stringio'
  string = StringIO.new(string)
  def string.read_until(char)
    val = ''
    while (c = self.read(1)) != char
      val << c
    end
    val
  end

  classmap ||= Hash.new

  do_unserialize(string, classmap, assoc)
end