basic API docs
[awesomized/ext-ion] / docs / html / ion / serialize.html
1 <!doctype html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <title>
6 serialize -
7 mdref
8 </title>
9 <meta name="viewport" content="width=1200, initial-scale=0.5">
10 <base href="/">
11 <meta http-equiv="Content-Location" content="/ion/serialize">
12 <link rel="stylesheet" href="index.css">
13
14 <link href="https://fonts.googleapis.com/css?family=Inconsolata&amp;subset=latin-ext" rel="stylesheet">
15 <script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
16 <link rel="shortcut icon" href="/favicon.ico">
17 </head>
18 <body>
19 <div class="page">
20
21 <div class="sidebar">
22
23 <div class="edit">
24 <a href="./ion/serialize">Edit</a>
25 </div>
26
27
28 <ul>
29 <li>&lsh; <a href="./">Home</a>
30
31 <ul>
32 <li>
33
34 &uarr; <a href="./ion">
35 ion
36 </a>
37 <ul>
38 <li>
39
40 &circlearrowright; <strong><a href="./ion/serialize">serialize</a></strong>
41
42
43
44 </ul>
45
46 <li>&ldsh; <a href="./ion/Catalog">Catalog</a></li>
47
48 <li>&ldsh; <a href="./ion/Decimal">Decimal</a></li>
49
50 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
51
52 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
53
54 <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
55
56 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
57
58 <li>&ldsh; <a href="./ion/Symbol">Symbol</a></li>
59
60 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
61
62 <li>&ldsh; <a href="./ion/Type">Type</a></li>
63
64 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
65
66 <li>&ldsh; <a href="./ion/Writer">Writer</a></li>
67
68 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
69
70 </li>
71 </ul>
72
73 </li>
74 </ul>
75 </div>
76
77 <h1>string ion\serialize(mixed $data, [?ion\Serializer $serializer = NULL])</h1>
78 <p>Serialize a PHP value as ION data.</p>
79 <p>Serializes supported PHP values with the optionally provided \ion\Serializer:</p>
80 <ul>
81 <li>NULL</li>
82 <li>bool</li>
83 <li>int</li>
84 <li>float</li>
85 <li>string</li>
86 <li>references</li>
87 <li>arrays</li>
88 <li>objects (incl. \Serializable, and classes implementing magic and custom __serialize)</li>
89 </ul>
90 <h2>Params:<a id="Params:" href="#Params:" class="permalink" aria-hidden="true" title="">#</a></h2>
91 <ul>
92 <li>mixed $data<br />
93 PHP value(s).</li>
94 <li>Optional ?ion\Serializer $serializer = NULL<br />
95 Custom serializer.</li>
96 </ul>
97 <h2>Returns:<a id="Returns:" href="#Returns:" class="permalink" aria-hidden="true" title="">#</a></h2>
98 <ul>
99 <li>string, serialized ION data</li>
100 </ul>
101
102
103
104
105 <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
106 <script>
107 var disqus_shortname = 'mdref';
108 var disqus_identifier = 'ion/serialize';
109 </script>
110
111 <footer>
112
113 <ul>
114 <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
115 </a></li>
116 <li><a href="LICENSE">&copy; 2013-2022 All rights reserved.</a></li>
117 <li>
118 </li>
119 </ul>
120
121 </footer>
122
123 <script src="index.js"></script>
124
125 </div>
126 </body>
127 </html>