Zend_Serializer-Adapter.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 21818 -->
  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>Siehe <xref linkend= "zend.json.advanced.objects1"/></entry>
  123. </row>
  124. <row>
  125. <entry><emphasis>objectDecodeType</emphasis></entry>
  126. <entry><type>Zend_Json::TYPE_*</type></entry>
  127. <entry>Zend_Json::TYPE_ARRAY</entry>
  128. <entry>Siehe <xref linkend= "zend.json.advanced.objects1"/></entry>
  129. </row>
  130. <row>
  131. <entry><emphasis>enableJsonExprFinder</emphasis></entry>
  132. <entry><type>boolean</type></entry>
  133. <entry>false</entry>
  134. <entry>Siehe <xref linkend= "zend.json.advanced.expr"/></entry>
  135. </row>
  136. </tbody>
  137. </tgroup>
  138. </table>
  139. </sect2>
  140. <sect2 id="zend.serializer.adapter.amf03">
  141. <title>Zend_Serializer_Adapter_Amf 0 und 3</title>
  142. <para>
  143. Die <acronym>AMF</acronym> Adapter <classname>Zend_Serializer_Adapter_Amf0</classname>
  144. und <classname>Zend_Serializer_Adapter_Amf3</classname> bieten eine Brücke zum
  145. Serialisierer der Komponente <classname>Zend_Amf</classname>. Lesen Sie bitte die <link
  146. linkend= "zend.amf.introduction">Zend_Amf Dokumentation</link> für weitere
  147. Informationen.
  148. </para>
  149. <para>
  150. Es gibt keine Optionen für diese Adapter.
  151. </para>
  152. </sect2>
  153. <sect2 id="zend.serializer.adapter.pythonpickle">
  154. <title>Zend_Serializer_Adapter_PythonPickle</title>
  155. <para>
  156. Dieser Adapter konvertiert <acronym>PHP</acronym> Typen in eine <ulink
  157. url="http://docs.python.org/library/pickle.html">Python Pickle</ulink> String
  158. Repräsentation. Mit Ihm können die serialisierten Daten mit Python gelesen werden und
  159. Pickled Daten von Python mit <acronym>PHP</acronym> gelesen werden.
  160. </para>
  161. <para>
  162. Vorhandene Optionen sind:
  163. </para>
  164. <table id="zend.serializer.adapter.pythonpickle.table.options">
  165. <title>Optionen für Zend_Serializer_Adapter_PythonPickle</title>
  166. <tgroup cols="4">
  167. <thead>
  168. <row>
  169. <entry>Option</entry>
  170. <entry>Datentyp</entry>
  171. <entry>Standardwert</entry>
  172. <entry>Beschreibung</entry>
  173. </row>
  174. </thead>
  175. <tbody>
  176. <row>
  177. <entry><emphasis>protocol</emphasis></entry>
  178. <entry><type>integer</type> (0 | 1 | 2 | 3)</entry>
  179. <entry>0</entry>
  180. <entry>
  181. Die Version des Pickle Protokolls welches bei
  182. <methodname>serialize</methodname> verwendet wird
  183. </entry>
  184. </row>
  185. </tbody>
  186. </tgroup>
  187. </table>
  188. <para>
  189. Der Wechsel von Datentypen (PHP zu Python) findet wie folgt statt:
  190. </para>
  191. <table id="zend.serializer.adapter.pythonpickle.table.php2python">
  192. <title>Wechseln des Datentyps (PHP zu Python)</title>
  193. <tgroup cols="2">
  194. <thead>
  195. <row>
  196. <entry>PHP Typ</entry>
  197. <entry>Python Typ</entry>
  198. </row>
  199. </thead>
  200. <tbody>
  201. <row>
  202. <entry><type>NULL</type></entry>
  203. <entry><type>None</type></entry>
  204. </row>
  205. <row>
  206. <entry><type>boolean</type></entry>
  207. <entry><type>boolean</type></entry>
  208. </row>
  209. <row>
  210. <entry><type>integer</type></entry>
  211. <entry><type>integer</type></entry>
  212. </row>
  213. <row>
  214. <entry><type>float</type></entry>
  215. <entry><type>float</type></entry>
  216. </row>
  217. <row>
  218. <entry><type>string</type></entry>
  219. <entry><type>string</type></entry>
  220. </row>
  221. <row>
  222. <entry><type>array</type></entry>
  223. <entry><type>list</type></entry>
  224. </row>
  225. <row>
  226. <entry><type>associative array</type></entry>
  227. <entry><type>dictionary</type></entry>
  228. </row>
  229. <row>
  230. <entry><type>object</type></entry>
  231. <entry><type>dictionary</type></entry>
  232. </row>
  233. </tbody>
  234. </tgroup>
  235. </table>
  236. <para>
  237. Der Wechsel von Datentypen (Python zu <acronym>PHP</acronym>) findet wie folgt statt:
  238. </para>
  239. <table id="zend.serializer.adapter.pythonpickle.table.python2php">
  240. <title>Wechseln des Datentyps (PHP zu Python)</title>
  241. <tgroup cols="2">
  242. <thead>
  243. <row>
  244. <entry>Python Typ</entry>
  245. <entry>PHP Typ</entry>
  246. </row>
  247. </thead>
  248. <tbody>
  249. <row>
  250. <entry><type>None</type></entry>
  251. <entry><type>NULL</type></entry>
  252. </row>
  253. <row>
  254. <entry><type>boolean</type></entry>
  255. <entry><type>boolean</type></entry>
  256. </row>
  257. <row>
  258. <entry><type>integer</type></entry>
  259. <entry><type>integer</type></entry>
  260. </row>
  261. <row>
  262. <entry><type>long</type></entry>
  263. <entry>
  264. <type>integer</type> | <type>float</type> | <type>string</type>
  265. | <classname>Zend_Serializer_Exception</classname>
  266. </entry>
  267. </row>
  268. <row>
  269. <entry><type>float</type></entry>
  270. <entry><type>float</type></entry>
  271. </row>
  272. <row>
  273. <entry><type>string</type></entry>
  274. <entry><type>string</type></entry>
  275. </row>
  276. <row>
  277. <entry><type>bytes</type></entry>
  278. <entry><type>string</type></entry>
  279. </row>
  280. <row>
  281. <entry><type>Unicode string</type></entry>
  282. <entry><type>UTF-8 string</type></entry>
  283. </row>
  284. <row>
  285. <entry><type>list</type></entry>
  286. <entry><type>array</type></entry>
  287. </row>
  288. <row>
  289. <entry><type>tuple</type></entry>
  290. <entry><type>array</type></entry>
  291. </row>
  292. <row>
  293. <entry><type>dictionary</type></entry>
  294. <entry><type>associative array</type></entry>
  295. </row>
  296. <row>
  297. <entry>Alle anderen Typen</entry>
  298. <entry><classname>Zend_Serializer_Exception</classname></entry>
  299. </row>
  300. </tbody>
  301. </tgroup>
  302. </table>
  303. </sect2>
  304. <sect2 id="zend.serializer.adapter.phpcode">
  305. <title>Zend_Serializer_Adapter_PhpCode</title>
  306. <para>
  307. Dieser Adapter erzeugt eine Repräsentation an <acronym>PHP</acronym> Code der geparst
  308. werden kann indem <ulink
  309. url="http://php.net/manual/function.var-export.php">var_export()</ulink>
  310. verwendet wird. Bei der Wiederherstellung werden die Daten ausgeführt indem <ulink
  311. url="http://php.net/manual/function.eval.php">eval</ulink> verwendet wird.
  312. </para>
  313. <para>
  314. Es gibt keine Optionen für die Konfiguration dieses Adapters.
  315. </para>
  316. <warning>
  317. <title>Objekte deserialisieren</title>
  318. <para>
  319. Objekte werden serialisiert indem die magische Methode <ulink
  320. url="http://php.net/manual/language.oop5.magic.php#language.oop5.magic.set-state">__set_state</ulink>
  321. verwendet wird. Wenn die Klasse diese Methode nicht implementiert wird wärend der
  322. Ausführung ein fataler Fehler auftreten.
  323. </para>
  324. </warning>
  325. <warning>
  326. <title>Verwendet eval()</title>
  327. <para>
  328. Der Adapter <classname>PhpCode</classname> verwendet <methodname>eval()</methodname>
  329. für die Deserialisierung. Das führt sowohl zu Performanz- als auch zu einem
  330. potentiellen Sicherheitsproblem da ein neuer Prozess ausgeführt wird. Typischerweise
  331. sollte der Adapter <methodname>PhpSerialize</methodname> verwendet werden solange
  332. man die Lesbarkeit der serialisierten Daten durch Menschen benötigt.
  333. </para>
  334. </warning>
  335. </sect2>
  336. </sect1>