Zend_Serializer-Adapter.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.serializer.adapter">
  5. <title>Zend_Serializer_Adapter</title>
  6. <para>
  7. <classname>Zend_Serializer</classname> Adapter erzeugen eine Brücke für unterschiedliche
  8. Methoden der Serialisierung mit geringem Aufwand.
  9. </para>
  10. <para>
  11. Jeder Adpater hat andere Vor- und Nachteile. In einigen Fällen kann nicht jeder
  12. <acronym>PHP</acronym> Datentyp (z.B. Objekte) in die Repräsentation eines Strings
  13. konvertiert werden. In den meisten dieser Fälle wird der Typ in einen ähnlichen Typ
  14. konvertiert der serialisierbar ist -- zum Beispiel werden <acronym>PHP</acronym> Objekte oft
  15. zu Arrays gecastet. Wenn dies fehlschlägt wird eine
  16. <classname>Zend_Serializer_Exception</classname> geworfen.
  17. </para>
  18. <para>
  19. Anbei ist eine Liste der vorhandenen Adapter.
  20. </para>
  21. <sect2 id="zend.serializer.adapter.phpserialize">
  22. <title>Zend_Serializer_Adapter_PhpSerialize</title>
  23. <para>
  24. Dieser Adapter verwendet die eingebauten <acronym>PHP</acronym> Funktionen
  25. <methodname>un/serialize</methodname> und ist eine gute Wahl für einen Standardadapter.
  26. </para>
  27. <para>
  28. Es gibt keine konfigurierbaren Optionen für diesen Adapter.
  29. </para>
  30. </sect2>
  31. <sect2 id="zend.serializer.adapter.igbinary">
  32. <title>Zend_Serializer_Adapter_Igbinary</title>
  33. <para>
  34. <ulink url="http://opensource.dynamoid.com">Igbinary</ulink> ist eine Open Source
  35. Software welche von Sulake Dynamoid Oy herausgegeben wird. Statt Zeit und Platz auf
  36. eine textuelle Repräsentation zu verschwenden, speichert igbinary Datenstrukturen von
  37. <acronym>PHP</acronym> in einer kompakten binären Form. Die Einsparungen sind
  38. signifikant wenn memcached oder ähnliche Hauptspeicher-basierte Speicher für die
  39. Serialisierung der Daten verwendet wird.
  40. </para>
  41. <para>
  42. Man muss die <acronym>PHP</acronym> Erweiterung igbinary am eigenen System installiert
  43. haben um diesen Adapter verwenden zu können.
  44. </para>
  45. <para>
  46. Dieser Adapter nimnt keine Optionen zur Konfiguration an.
  47. </para>
  48. </sect2>
  49. <sect2 id="zend.serializer.adapter.wddx">
  50. <title>Zend_Serializer_Adapter_Wddx</title>
  51. <para>
  52. <ulink url="http://wikipedia.org/wiki/WDDX">WDDX</ulink> (Web Distributed Data eXchange)
  53. ist eine Programmier-Sprache-, Plattform- und ein transport-neutraler datentauschender
  54. Mechanismus für die Übergabe von Daten zwischen unterschiedlichen Umgebungen und
  55. unterschiedlichen Computern.
  56. </para>
  57. <para>
  58. Der Adapter verwendet einfach die <ulink
  59. url="http://php.net/manual/book.wddx.php">wddx_*()</ulink> <acronym>PHP</acronym>
  60. Funktionen. Lesen Sie bitte im <acronym>PHP</acronym> Handbuch um herauszufinden ob man
  61. Sie in der eigenen <acronym>PHP</acronym> Installation aktivieren kann.
  62. </para>
  63. <para>
  64. Zusätzlich wird die <acronym>PHP</acronym> Erweiterung <ulink
  65. url="http://php.net/manual/book.simplexml.php">SimpleXML</ulink> verwendet um zu
  66. prüfen ob ein von <methodname>wddx_unserialize()</methodname> zurückgegebener
  67. <constant>NULL</constant> Wert auf einem serialisierten <constant>NULL</constant> Wert
  68. basiert, oder auf ungültigen Daten.
  69. </para>
  70. <para>
  71. Vorhandene Optionen sind:
  72. </para>
  73. <table id="zend.serializer.adapter.wddx.table.options">
  74. <title>Optionen für Zend_Serializer_Adapter_Wddx</title>
  75. <tgroup cols="4">
  76. <thead>
  77. <row>
  78. <entry>Option</entry>
  79. <entry>Datentyp</entry>
  80. <entry>Standardwert</entry>
  81. <entry>Beschreibung</entry>
  82. </row>
  83. </thead>
  84. <tbody>
  85. <row>
  86. <entry><emphasis>comment</emphasis></entry>
  87. <entry><type>string</type></entry>
  88. <entry></entry>
  89. <entry>Ein optionales Kommentar welches im Paket Header vorkommt.</entry>
  90. </row>
  91. </tbody>
  92. </tgroup>
  93. </table>
  94. </sect2>
  95. <sect2 id="zend.serializer.adapter.json">
  96. <title>Zend_Serializer_Adapter_Json</title>
  97. <para>
  98. Der <acronym>JSON</acronym> Adapter bietet eine Brücke zur Komponente
  99. <classname>Zend_Json</classname> und zu ext/json. Lesen Sie bitte die <link
  100. linkend= "zend.json.introduction">Zend_Json Dokumentation</link> für weitere
  101. Informationen.
  102. </para>
  103. <para>
  104. Vorhandene Optionen sind:
  105. </para>
  106. <table id="zend.serializer.adapter.json.table.options">
  107. <title>Optionen für Zend_Serializer_Adapter_Json</title>
  108. <tgroup cols="4">
  109. <thead>
  110. <row>
  111. <entry>Option</entry>
  112. <entry>Datentyp</entry>
  113. <entry>Standardwert</entry>
  114. <entry>Beschreibung</entry>
  115. </row>
  116. </thead>
  117. <tbody>
  118. <row>
  119. <entry><emphasis>cycleCheck</emphasis></entry>
  120. <entry><type>boolean</type></entry>
  121. <entry>false</entry>
  122. <entry>
  123. Siehe <link linkend= "zend.json.advanced.objects1">diesen
  124. Abschnitt</link>
  125. </entry>
  126. </row>
  127. <row>
  128. <entry><emphasis>objectDecodeType</emphasis></entry>
  129. <entry><type>Zend_Json::TYPE_*</type></entry>
  130. <entry>Zend_Json::TYPE_ARRAY</entry>
  131. <entry>
  132. Siehe <link linkend= "zend.json.advanced.objects1">diesen
  133. Abschnitt</link>
  134. </entry>
  135. </row>
  136. <row>
  137. <entry><emphasis>enableJsonExprFinder</emphasis></entry>
  138. <entry><type>boolean</type></entry>
  139. <entry>false</entry>
  140. <entry>
  141. Siehe <link linkend= "zend.json.advanced.expr">diesen
  142. Abschnitt</link>
  143. </entry>
  144. </row>
  145. </tbody>
  146. </tgroup>
  147. </table>
  148. </sect2>
  149. <sect2 id="zend.serializer.adapter.amf03">
  150. <title>Zend_Serializer_Adapter_Amf 0 und 3</title>
  151. <para>
  152. Die <acronym>AMF</acronym> Adapter <classname>Zend_Serializer_Adapter_Amf0</classname>
  153. und <classname>Zend_Serializer_Adapter_Amf3</classname> bieten eine Brücke zum
  154. Serialisierer der Komponente <classname>Zend_Amf</classname>. Lesen Sie bitte die <link
  155. linkend= "zend.amf.introduction">Zend_Amf Dokumentation</link> für weitere
  156. Informationen.
  157. </para>
  158. <para>
  159. Es gibt keine Optionen für diese Adapter.
  160. </para>
  161. </sect2>
  162. <sect2 id="zend.serializer.adapter.pythonpickle">
  163. <title>Zend_Serializer_Adapter_PythonPickle</title>
  164. <para>
  165. Dieser Adapter konvertiert <acronym>PHP</acronym> Typen in eine <ulink
  166. url="http://docs.python.org/library/pickle.html">Python Pickle</ulink> String
  167. Repräsentation. Mit Ihm können die serialisierten Daten mit Python gelesen werden und
  168. Pickled Daten von Python mit <acronym>PHP</acronym> gelesen werden.
  169. </para>
  170. <para>
  171. Vorhandene Optionen sind:
  172. </para>
  173. <table id="zend.serializer.adapter.pythonpickle.table.options">
  174. <title>Optionen für Zend_Serializer_Adapter_PythonPickle</title>
  175. <tgroup cols="4">
  176. <thead>
  177. <row>
  178. <entry>Option</entry>
  179. <entry>Datentyp</entry>
  180. <entry>Standardwert</entry>
  181. <entry>Beschreibung</entry>
  182. </row>
  183. </thead>
  184. <tbody>
  185. <row>
  186. <entry><emphasis>protocol</emphasis></entry>
  187. <entry><type>integer</type> (0 | 1 | 2 | 3)</entry>
  188. <entry>0</entry>
  189. <entry>
  190. Die Version des Pickle Protokolls welches bei
  191. <methodname>serialize</methodname> verwendet wird
  192. </entry>
  193. </row>
  194. </tbody>
  195. </tgroup>
  196. </table>
  197. <para>
  198. Der Wechsel von Datentypen (PHP zu Python) findet wie folgt statt:
  199. </para>
  200. <table id="zend.serializer.adapter.pythonpickle.table.php2python">
  201. <title>Wechseln des Datentyps (PHP zu Python)</title>
  202. <tgroup cols="2">
  203. <thead>
  204. <row>
  205. <entry>PHP Typ</entry>
  206. <entry>Python Typ</entry>
  207. </row>
  208. </thead>
  209. <tbody>
  210. <row>
  211. <entry><type>NULL</type></entry>
  212. <entry><type>None</type></entry>
  213. </row>
  214. <row>
  215. <entry><type>boolean</type></entry>
  216. <entry><type>boolean</type></entry>
  217. </row>
  218. <row>
  219. <entry><type>integer</type></entry>
  220. <entry><type>integer</type></entry>
  221. </row>
  222. <row>
  223. <entry><type>float</type></entry>
  224. <entry><type>float</type></entry>
  225. </row>
  226. <row>
  227. <entry><type>string</type></entry>
  228. <entry><type>string</type></entry>
  229. </row>
  230. <row>
  231. <entry><type>array</type></entry>
  232. <entry><type>list</type></entry>
  233. </row>
  234. <row>
  235. <entry><type>associative array</type></entry>
  236. <entry><type>dictionary</type></entry>
  237. </row>
  238. <row>
  239. <entry><type>object</type></entry>
  240. <entry><type>dictionary</type></entry>
  241. </row>
  242. </tbody>
  243. </tgroup>
  244. </table>
  245. <para>
  246. Der Wechsel von Datentypen (Python zu <acronym>PHP</acronym>) findet wie folgt statt:
  247. </para>
  248. <table id="zend.serializer.adapter.pythonpickle.table.python2php">
  249. <title>Wechseln des Datentyps (PHP zu Python)</title>
  250. <tgroup cols="2">
  251. <thead>
  252. <row>
  253. <entry>Python Typ</entry>
  254. <entry>PHP Typ</entry>
  255. </row>
  256. </thead>
  257. <tbody>
  258. <row>
  259. <entry><type>None</type></entry>
  260. <entry><type>NULL</type></entry>
  261. </row>
  262. <row>
  263. <entry><type>boolean</type></entry>
  264. <entry><type>boolean</type></entry>
  265. </row>
  266. <row>
  267. <entry><type>integer</type></entry>
  268. <entry><type>integer</type></entry>
  269. </row>
  270. <row>
  271. <entry><type>long</type></entry>
  272. <entry>
  273. <type>integer</type> | <type>float</type> | <type>string</type>
  274. | <classname>Zend_Serializer_Exception</classname>
  275. </entry>
  276. </row>
  277. <row>
  278. <entry><type>float</type></entry>
  279. <entry><type>float</type></entry>
  280. </row>
  281. <row>
  282. <entry><type>string</type></entry>
  283. <entry><type>string</type></entry>
  284. </row>
  285. <row>
  286. <entry><type>bytes</type></entry>
  287. <entry><type>string</type></entry>
  288. </row>
  289. <row>
  290. <entry><type>Unicode string</type></entry>
  291. <entry><type>UTF-8 string</type></entry>
  292. </row>
  293. <row>
  294. <entry><type>list</type></entry>
  295. <entry><type>array</type></entry>
  296. </row>
  297. <row>
  298. <entry><type>tuple</type></entry>
  299. <entry><type>array</type></entry>
  300. </row>
  301. <row>
  302. <entry><type>dictionary</type></entry>
  303. <entry><type>associative array</type></entry>
  304. </row>
  305. <row>
  306. <entry>Alle anderen Typen</entry>
  307. <entry><classname>Zend_Serializer_Exception</classname></entry>
  308. </row>
  309. </tbody>
  310. </tgroup>
  311. </table>
  312. </sect2>
  313. <sect2 id="zend.serializer.adapter.phpcode">
  314. <title>Zend_Serializer_Adapter_PhpCode</title>
  315. <para>
  316. Dieser Adapter erzeugt eine Repräsentation an <acronym>PHP</acronym> Code der geparst
  317. werden kann indem <ulink
  318. url="http://php.net/manual/function.var-export.php">var_export()</ulink>
  319. verwendet wird. Bei der Wiederherstellung werden die Daten ausgeführt indem <ulink
  320. url="http://php.net/manual/function.eval.php">eval</ulink> verwendet wird.
  321. </para>
  322. <para>
  323. Es gibt keine Optionen für die Konfiguration dieses Adapters.
  324. </para>
  325. <warning>
  326. <title>Objekte deserialisieren</title>
  327. <para>
  328. Objekte werden serialisiert indem die magische Methode <ulink
  329. url="http://php.net/manual/language.oop5.magic.php#language.oop5.magic.set-state">__set_state</ulink>
  330. verwendet wird. Wenn die Klasse diese Methode nicht implementiert wird während der
  331. Ausführung ein fataler Fehler auftreten.
  332. </para>
  333. </warning>
  334. <warning>
  335. <title>Verwendet eval()</title>
  336. <para>
  337. Der Adapter <classname>PhpCode</classname> verwendet <methodname>eval()</methodname>
  338. für die Deserialisierung. Das führt sowohl zu Performanz- als auch zu einem
  339. potentiellen Sicherheitsproblem da ein neuer Prozess ausgeführt wird. Typischerweise
  340. sollte der Adapter <methodname>PhpSerialize</methodname> verwendet werden solange
  341. man die Lesbarkeit der serialisierten Daten durch Menschen benötigt.
  342. </para>
  343. </warning>
  344. </sect2>
  345. </sect1>