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="/ext-ion/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/ext-ion/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="/ext-ion/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                                         <meta charset="utf-8"><h1>
  81 <a class="permalink" href="ion/serialize#">#</a><code><a href="https://php.net/manual/en/language.types.string">string</a></code> <a href="ion/serialize">ion\serialize</a>(<code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.mixed">mixed</a></code> <span class="var">$data</span>, [?<a href="ion/Serializer">ion\Serializer</a> <span class="var">$serializer</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>])</h1><p>Serialize a PHP value as ION data.</p><p>Serializes supported PHP values with the optionally provided <a href="ion/Serializer">\ion\Serializer:</a></p><ul>
  82 <li><code><a href="https://php.net/manual/en/language.types.null">NULL</a></code></li>
  83 <li><code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code></li>
  84 <li><code><a href="https://php.net/manual/en/language.types.integer">int</a></code></li>
  85 <li><code><a href="https://php.net/manual/en/language.types.float">float</a></code></li>
  86 <li><code><a href="https://php.net/manual/en/language.types.string">string</a></code></li>
  87 <li><code><a href="https://php.net/manual/en/language.references">reference</a></code></li>
  88 <li><code><a href="https://php.net/manual/en/language.types.array">array</a></code></li>
  89 <li>object (incl. <code><a href="https://php.net/manual/en/class.serializable">\Serializable</a></code>, and classes implementing magic and custom __serialize)</li>
  90 </ul><h2 id="Params:">Params:<a class="permalink" href="ion/serialize#Params:">#</a>
  91 </h2><ul>
  92 <li>
  93 <code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.mixed">mixed</a></code> <span class="var" id="$data">$data<a class="permalink" href="ion/serialize#%24data">#</a></span><br>
  94 PHP value(s).</li>
  95 <li>Optional ?<a href="ion/Serializer">ion\Serializer</a> <span class="var" id="$serializer">$serializer<a class="permalink" href="ion/serialize#%24serializer">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
  96 Custom serializer.</li>
  97 </ul><h2 id="Returns:">Returns:<a class="permalink" href="ion/serialize#Returns:">#</a>
  98 </h2><ul>
  99 <li>
 100 <code><a href="https://php.net/manual/en/language.types.string">string</a></code>, serialized ION data</li>
 101 </ul><h2 id="Throws:">Throws:<a class="permalink" href="ion/serialize#Throws:">#</a>
 102 </h2><ul>
 103 <li><a href="ion/Exception">\ion\Exception</a></li>
 104 </ul>
 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-v3.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>