local-lib5/man/man3/PHP::Serialization.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "PHP::Serialization 3"
 127 .TH PHP::Serialization 3 "2010-03-18" "perl v5.8.8" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 PHP::Serialization \- simple flexible means of converting the output of PHP's serialize() into the equivalent Perl memory structure, and vice versa.
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 3
 137 \&    use PHP::Serialization qw(serialize unserialize);
 138 \&    my $encoded = serialize({ a => 1, b => 2});
 139 \&    my $hashref = unserialize($encoded);
 140 .Ve
 141 .SH "DESCRIPTION"
 142 .IX Header "DESCRIPTION"
 143 Provides a simple, quick means of serializing perl memory structures (including object data!) into a format that \s-1PHP\s0 can \fIdeserialize()\fR and access, and vice versa.
 144 .PP
 145 \&\s-1NOTE:\s0 Converts \s-1PHP\s0 arrays into Perl Arrays when the \s-1PHP\s0 array used exclusively numeric indexes, and into Perl Hashes then the \s-1PHP\s0 array did not.
 146 .SH "FUNCTIONS"
 147 .IX Header "FUNCTIONS"
 148 Exportable functions..
 149 .ie n .SS "serialize($var,[optional $asString,[optional $sortHashes]])"
 150 .el .SS "serialize($var,[optional \f(CW$asString\fP,[optional \f(CW$sortHashes\fP]])"
 151 .IX Subsection "serialize($var,[optional $asString,[optional $sortHashes]])"
 152 Serializes the memory structure pointed to by \f(CW$var\fR, and returns a scalar value of encoded data.
 153 .PP
 154 If the optional \f(CW$asString\fR is true, \f(CW$var\fR will be encoded as string if it is double or float.
 155 .PP
 156 If the optional \f(CW$sortHashes\fR is true, all hashes will be sorted before serialization.
 157 .PP
 158 \&\s-1NOTE:\s0 Will recursively encode objects, hashes, arrays, etc.
 159 .PP
 160 \&\s-1SEE\s0 \s-1ALSO:\s0 \->\fIencode()\fR
 161 .SS "unserialize($encoded,[optional \s-1CLASS\s0])"
 162 .IX Subsection "unserialize($encoded,[optional CLASS])"
 163 Deserializes the encoded data in \f(CW$encoded\fR, and returns a value (be it a hashref, arrayref, scalar, etc)
 164 representing the data structure serialized in \f(CW$encoded_string\fR.
 165 .PP
 166 If the optional \s-1CLASS\s0 is specified, any objects are blessed into CLASS::$serialized_class. Otherwise, O
 167 bjects are blessed into PHP::Serialization::Object::$serialized_class. (which has no methods)
 168 .PP
 169 \&\s-1SEE\s0 \s-1ALSO:\s0 \->\fIdecode()\fR
 170 .SH "METHODS"
 171 .IX Header "METHODS"
 172 Functionality available if using the object interface..
 173 .SS "decode($encoded_string,[optional \s-1CLASS\s0])"
 174 .IX Subsection "decode($encoded_string,[optional CLASS])"
 175 Deserializes the encoded data in \f(CW$encoded\fR, and returns a value (be it a hashref, arrayref, scalar, etc)
 176 representing the data structure serialized in \f(CW$encoded_string\fR.
 177 .PP
 178 If the optional \s-1CLASS\s0 is specified, any objects are blessed into CLASS::$serialized_class. Otherwise,
 179 Objects are blessed into PHP::Serialization::Object::$serialized_class. (which has no methods)
 180 .PP
 181 \&\s-1SEE\s0 \s-1ALSO:\s0 \fIunserialize()\fR
 182 .ie n .SS "encode($reference,[optional $asString,[optional $sortHashes]])"
 183 .el .SS "encode($reference,[optional \f(CW$asString\fP,[optional \f(CW$sortHashes\fP]])"
 184 .IX Subsection "encode($reference,[optional $asString,[optional $sortHashes]])"
 185 Serializes the memory structure pointed to by \f(CW$reference\fR, and returns a scalar value of encoded data.
 186 .PP
 187 If the optional \f(CW$asString\fR is true, \f(CW$reference\fR will be encoded as string if it is double or float.
 188 .PP
 189 If the optional \f(CW$sortHashes\fR is true, all hashes will be sorted before serialization.
 190 .PP
 191 \&\s-1NOTE:\s0 Will recursively encode objects, hashes, arrays, etc.
 192 .PP
 193 \&\s-1SEE\s0 \s-1ALSO:\s0 \fIserialize()\fR
 194 .SH "TODO"
 195 .IX Header "TODO"
 196 Support diffrent object types
 197 .SH "AUTHOR INFORMATION"
 198 .IX Header "AUTHOR INFORMATION"
 199 Copyright (c) 2003 Jesse Brown <jbrown@cpan.org>. All rights reserved. This program is free software;
 200 you can redistribute it and/or modify it under the same terms as Perl itself.
 201 .PP
 202 Various patches contributed by assorted authors on rt.cpan.org (as detailed in Changes file).
 203 .PP
 204 Currently maintained by Tomas Doran <bobtfish@bobtfish.net>.
 205 .PP
 206 Rewritten to solve all known bugs by BjA\*~Xrn\-Olav Strand <bolav@cpan.org>