git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.0/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="/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/v0.0/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="/v0.0/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/: Contributing">★ Contributing</a></li>
  47
  48                                                 <li>&ldsh; <a href="./ion/: Security">★ Security</a></li>
  49
  50                                                 <li>&ldsh; <a href="./ion/Catalog">Catalog</a></li>
  51
  52                                                 <li>&ldsh; <a href="./ion/Decimal">Decimal</a></li>
  53
  54                                                 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
  55
  56                                                 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
  57
  58                                                 <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
  59
  60                                                 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
  61
  62                                                 <li>&ldsh; <a href="./ion/Symbol">Symbol</a></li>
  63
  64                                                 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
  65
  66                                                 <li>&ldsh; <a href="./ion/Type">Type</a></li>
  67
  68                                                 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
  69
  70                                                 <li>&ldsh; <a href="./ion/Writer">Writer</a></li>
  71
  72                                                 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
  73
  74                                 </li>
  75                         </ul>
  76
  77                 </li>
  78         </ul>
  79 </div>
  80
  81 <h1>string ion\serialize(mixed $data, [?ion\Serializer $serializer = NULL])</h1>
  82 <p>Serialize a PHP value as ION data.</p>
  83 <p>Serializes supported PHP values with the optionally provided \ion\Serializer:</p>
  84 <ul>
  85 <li>NULL</li>
  86 <li>bool</li>
  87 <li>int</li>
  88 <li>float</li>
  89 <li>string</li>
  90 <li>references</li>
  91 <li>arrays</li>
  92 <li>objects (incl. \Serializable, and classes implementing magic and custom __serialize)</li>
  93 </ul>
  94 <h2>Params:<a id="Params:" href="#Params:" class="permalink" aria-hidden="true" title="">#</a></h2>
  95 <ul>
  96 <li>mixed $data<br />
  97 PHP value(s).</li>
  98 <li>Optional ?ion\Serializer $serializer = NULL<br />
  99 Custom serializer.</li>
 100 </ul>
 101 <h2>Returns:<a id="Returns:" href="#Returns:" class="permalink" aria-hidden="true" title="">#</a></h2>
 102 <ul>
 103 <li>string, serialized ION data</li>
 104 </ul>
 105
 106
 107
 108
 109                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 110                         <script>
 111                                 var disqus_shortname = 'mdref';
 112                                 var disqus_identifier = 'ion/serialize';
 113                         </script>
 114
 115                         <footer>
 116
 117 <ul>
 118         <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
 119 </a></li>
 120         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 121         <li>
 122 </li>
 123 </ul>
 124
 125                         </footer>
 126
 127                         <script src="index.js"></script>
 128
 129                 </div>
 130         </body>
 131 </html>